<!--
SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)
SPDX-FileCopyrightText: 2021 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)

SPDX-License-Identifier: CC0-1.0
-->

# 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 as [issue](https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance/-/issues).

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.

### 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 "enhancement" and "help wanted" is open to whoever wants to implement it.

### Write Documentation

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

### Submit Feedback

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 :)

## Commit Changes

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

1. Fork the `Software Quality Assurance` repo on GitLab.
2. Clone your fork locally:
    ```shell
    $ git clone git@git.gfz-potsdam.de:your_name_here/software-quality-assurance.git
    ```
3. Create a branch for local development from the dev branch:
    ```shell
    $ git checkout -b name-of-your-bugfix-or-feature dev
    ```
    Now you can make your changes locally.
4. Commit your changes and push your branch to GitLab:
    ```shell
    $ git add .
    $ git commit -m "Your detailed description of your changes."
    $ git push origin name-of-your-bugfix-or-feature
    ```
5. When you're done making changes, check that your changes pass the code style and the software tests by running the CI.

6. Submit a merge request through the GitLab website.

<!--
#### Sign your commits

Please note that our license terms only allow signed commits.
A guideline how to sign your work can be found [here](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work)

If you are using the PyCharm IDE, the `Commit changes` dialog has an option called `Sign-off commit` to
automatically sign your work.
-->

## 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.
3. Check your [merge request](https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance/-/merge_requests) and make sure that the tests pass.
4. All changes need to be compatible with the respective [license](README.md#license).