Contributing
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions
Report Bugs
Report bugs at https://git.passcal.nmt.edu/software_public/passoft/nexus/issues
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Fix Bugs
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.
Implement Features
Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
Write Documentation
nexus could always use more documentation, whether as part of the official nexus docs, in docstrings, or even on the web in blog posts, articles, and such.
Submit Feedback
The best way to send feedback is to file an issue at https://git.passcal.nmt.edu/passoft/nexus/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started!
Ready to contribute? Here's how to set up nexus for local development.
-
Cone the nexus repo:
$ git clone https://git.passcal.nmt.edu/software_public/passoft/nexus.git
-
Install your local copy:
$ pip install -e .[dev] -
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-featureNow you can make your changes locally.
-
When you're done making changes, check that your changes pass the tests:
$ python setup.py test -
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature -
Submit a merge request through the Gitlab website.