Skip to content

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

  1. Fork the gnss-calendar repository on GitLab.
  2. Clone your fork locally:

git clone git@git.gfz-potsdam.de:gnss/gnss-calendar.git
3. Install your local copy into a virtualenv. Assuming you have pyenv installed, this is how you set up your fork for local development:

pyenv activate <your-pyenv-name>
pip install -r requirements.txt
4. Create a branch for local development:

git checkout -b issue-<number>-<short-name-of-your-bugfix-or-feature>
5. When you're finished making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

python -m tox
6. Commit your changes and push your branch to GitLab:

git add .
git commit -m "Your detailed description of your changes."
git push origin issue-<number>-<short-name-of-your-bugfix-or-feature>
7. Submit a merge request through the GitLab website.

Merge Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The merge request should include tests.
  2. 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.
  3. 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.