DeepskyLog is a community effort built by amateur astronomers in their free time, so feel free to contribute in any way you can. Every contribution helps! Contributions are welcome and will be fully credited.
- Submit pull requests with new code to fix problems, or to add new functionality (see below for guidelines). Easy things to start with are labelled as good first issue.
- Open issues for things you want to see added or modified.
- Be part of the discussion by helping out with existing issues or talking on our slack channel.
- Write tests.
- Whenever you have questions on how to help, do not hesitate to contact us. We can set up one-to-one sessions to get you started.
- Please always be polite and helpfull. We are developing and maintaining DeepskyLog in our free time. See our code of conduct.
- Help developing DeepskyLog itself!
- Add tests! - Your patch won't be accepted if it doesn't have tests.
- Document any change in behaviour - Make sure the
readme.mdand any other relevant documentation are kept up-to-date. - Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.
- One pull request per feature - If you want to do more than one thing, send multiple pull requests.
- Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
Happy coding!