Thank you so much for considering to contribute to the project! We welcome all contributions, and we are grateful even for the smallest fixes. 🛠️🔎👷
The following is a set of guidelines for contributing to the project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
If you're worried you may be doing something wrong, ✨don't worry✨. If you're still
worried, though, know that everyone makes mistakes and we are here to help you
fix them. Our Code of Conduct outlines the commitment of
all who work on and contribute to astrodata to fostering a comfortable and
mutually supportive development environment.
Note: The image above links to an editable version of this chart.
Submit an issue to our GitHub issues for problems you are unsure you have a solution to, or do not currently have the time to work on yourself. Even if you may plan to work on it sometime in the future, it's useful to log the issue in case someone else is already working on it!
We include several issue templates with fill-in-the-answer style formatting to make your submission as quick and easy as possible. Ideally, you will provide a code snippet (if relevant) that reproduces the issue without any external dependencies. That's not always possible nor feasible, though, so don't hesitate to note you don't have one. Any code examples---even ones with external dependencies---are better than none!
Pull request are also managed on the astrodata GitHub
page. Pull requests
(PR's) let you contribute directly to the astrodata codebase with code,
documentation, or anything else you've written! These may seem more
intimidating than an issue, but the only real difference is that you are
contributing code.
Otherwise, the process is basically the same; contributers weigh in, the situation is discussed as needed, and at the end of the discussion the code is improved. There's no "finality" to a PR. There is always time to dicuss the changes as carefully as with an issue.
If this still feels too complicated or intimidating, feel free to raise an issue or contact a maintainer directly.
See GitHub's guide to contributing through PRs for more information about how to start a PR.
While it is preferred you contribute using one of the above methods, if discretion is required or you are having trouble please do not hesitate to reach out to one of the core maintainers directly:
- Teal ([email protected])