Contributing๏ƒ

First off, thank you for your interest in contributing to the AstroPT project! We welcome contributions from the community to improve AstroPT, and once your contribution is merged with the main branch you will be officially recognized as a contributor to the project!

Please take a moment to read this doc before submitting a pull request.

Where do I go from here?๏ƒ

If you have a question, roadmap suggestion, or an idea for AstroPT please ping us on the UniverseTBD ๐Ÿงช Discord. If youโ€™ve found a bug, please submit an issue.

Code of Conduct๏ƒ

Be excellent to each other.

How can I contribute?๏ƒ

There are many ways to contribute to AstroPT:

  1. Report bugs: If you find a bug, please create an issue on our GitHub repository

  2. Suggest features: Have an idea for a new feature? Open an issue to suggest it

  3. Improve documentation: Documentation is crucial for any project

  4. Submit pull requests: Implement new features or fix bugs

If you can implement your feature๏ƒ

If you can implement your proposed feature then fork AstroPT and create a branch with a descriptive name.

Once you have your feature implemented, open up a pull request and one of us will review the code and merge to main or come back with comments. If your pull request is connected to an issue or roadmap item please do not forget to link it.

Development environment๏ƒ

To set up a development environment:

# Clone the repository
git clone https://github.com/smith42/astropt.git
cd astropt

# Install development dependencies
uv sync