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 git.gfz-potsdam.de/gnss/tools/dateconv/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 GitLab issues for bugs. Anything tagged with "bug" is open to whoever wants to implement it.
Implement Features¶
Look through the GitLab issues for features. Anything tagged with "feature" is open to whoever wants to implement it.
Write Documentation¶
dateconv could always use more documentation, whether as part of the official dateconv 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 git.gfz-potsdam.de/gnss/tools/dateconv/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 dateconv
for local development.
- Fork the
dateconv
repo on GitLab. - Clone your fork locally:
-
Create a branch for local development:
Now you can make your changes locally. -
When you're done making changes, check that your changes pass the tests:
- Commit your changes and push your branch to GitLab:
- Submit a pull request through the GitLab website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the MkDocs documentation.