How to contribute to gnss-calendar¶
Contributions are welcome and greatly appreciated!
Types of Contributions¶
Find Bugs¶
Report bugs at https://git.gfz-potsdam.de/gnss/gnss-calendar/issues.
If you are reporting a bug, please make sure that the bug was not already reported.
If possible, add the following information to your report:
- 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 GitLab issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.
Implement Features¶
Look through the GitLab issues for features. Anything tagged with "feature" and "help wanted" is open to whoever wants to implement it.
Write Documentation¶
gnss-calendar could always use more documentation, whether as part of the official docs or in docstrings.
Submit Feedback¶
The best way to send feedback is to file an issue at https://git.gfz-potsdam.de/gnss/gnss-calendar/issues.
If you are proposing a feature:
- Explain in detail how it should work.
- Keep the scope as narrow as possible, to make it easier to implement.
Commit Changes¶
How to¶
- Fork the
gnss-calendar
repository on GitLab. - Clone your fork locally:
git add .
git commit -m "Your detailed description of your changes."
git push origin issue-<number>-<short-name-of-your-bugfix-or-feature>
Merge Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The merge request should include tests.
- If the merge request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
- The pull request should work for Python 3.6, 3.7, 3.8 and 3.9. Check https://git.gfz-potsdam.de/gnss/gnss-calendar/-/merge_requests and make sure that the tests pass for all supported Python versions.