We love spectroscopy, and we love your input! We want to make contributing to this project as easy as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code or the physics
- Submitting a fix
- Proposing new features (interface or physics)
- Becoming a core developer
This document is a quick summary, more information can be found on the Developer Guide
We use github to host code, to track issues and feature requests, as well as accept pull requests.
We (try to) use Github Flow
So all code changes (should) happen through Pull Requests. Pull requests are the best way to propose changes to the codebase:
- Fork the repo and create your branch from
develop. - If you've added code that should be tested, add tests.
- If you've added new features, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Open that pull request!
Report bugs using Github's issues
We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!
Issues labeled Good First Issue are also a nice way to get started with contributing to the project.
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
People love thorough bug reports. Not even kidding.
We're using the Black coding style. See the Developer Guide for more information.
See the Q&A forum or join the community chat:
You can suggest or vote for new features below:
By contributing, you agree that your contributions will be licensed under the GNU Lesser General Public License v3.0
This document was adapted from the open-source contribution guidelines of @briandk