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 as issue.

If you are reporting a bug, please include:

The docker version used.
The section of the .gitlab-ci.yml where you call the Software Quality Assurance.
Your sqa config
Your software-quality-assurance-report.md, if it was generated
Detailed steps to reproduce the bug.

Look through the GitLab issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Look through the GitLab issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Software Quality Assurance could always use more documentation. Whether as part of the official docs or in the docstrings.

The best way to send feedback is to file an issue at https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance/-/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 :)

Ready to contribute? Here’s how to set up Software Quality Assurance for local development.

Clone your fork locally:

$ git clone git@git.gfz-potsdam.de:your_name_here/software-quality-assurance.git

Create a branch for local development from the dev branch:
```
$ git checkout -b name-of-your-bugfix-or-feature dev
```
Now you can make your changes locally.

Commit your changes and push your branch to GitLab:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

When you’re done making changes, check that your changes pass the code style and the software tests by running the CI.
Submit a merge request through the GitLab website.

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