Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 2.02 KB

contributing.md

File metadata and controls

43 lines (30 loc) · 2.02 KB

Useful links and tips for contributing to the Astropy Ecosystem

Astropy webpage

Code Repos

Code repositories and organizational repositories for the Astropy project are located under the astropy github organization: https://github.com/astropy It includes repositories for the core library, a subset of affiliated packages and infrastructure packages that the project maintains.

Developer documentation

All astropy maintained packages follow the same developer workflow. This workflow is also very similar to the ones other open source projects follow, e.g. numpy, or scikit-learn, but nevertheless it is worth double checking their preferences before contributing.

Tip: Always consult the developer documentations from the latest (developer version) docs rendering rather as procedures may change or clarified compared to previous iterations. Repos may include a CONTRIBUTING.md file, too which usually provides directions to start.

A worked out example of fixing a bug in astropy: https://docs.astropy.org/en/latest/development/workflow/git_edit_workflow_examples.html#astropy-fix-example

All the developer related documents that go beyond the workflow are listed here: https://docs.astropy.org/en/latest/#developer-documentation

Community