CONTRIBUTING.rst 1.3 KB
Newer Older
1
2
3
4
5
6
7
8
============================
Contributing to Discuss Data
============================

As an open source project, Discuss Data welcomes contributions of many forms.

Examples of contributions include:

9
* Vulnerability reports
10
11
12
13
14
15
* Code patches
* Documentation improvements
* `Bug reports`_ and patch reviews
* Feature requests
* Merge requests

16
17
18
19
20
21
22
23
24
25
Vulnerability reports
=====================

If you need to report a vulnerability, please send an E-Mail to gitlab+discuss-data-discuss-data-9289-issue-@gwdg.de
Be aware that, by default, your E-Mail will be sent unencrypted.

Code patches
============

Discuss Data uses pre-commit hooks to ensure the compliance of contributions with our coding standards.::
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

  pre-commit install

Commits have to follow the conventional commit standard. This repo is configured
commitizen friendly so that you can use it to comply with our commit format.

We welcome and are likely to accept merge requests that follow the aforesaid.

.. _`Bug reports`: https://gitlab.gwdg.de/discuss-data/discuss-data/-/issues


How to fix a Bug
================

To contribute by fixing a Bug, follow these steps:

#. Write a test that
    - reproduces the wanted behaviour and
    - fails because of the bug.

#. Write a fix that
    - produces the wanted behaviour and
    - lets the previosly written test pass.