1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
# Contributing
We welcome contributions in several forms, for instance:
* Documenting
* Testing / Bug reports
* Coding
* etc.
Please read [14 Ways to Contribute to Open Source without Being a Programming
Genius or a Rock
Star](https://smartbear.com/blog/test-and-monitor/14-ways-to-contribute-to-open-source-without-being/).
## Developer Certificate of Origin
All commits must be signed-off by their author when contributing.
When signing-off a patch for this project like this
Signed-off-by: Random J Developer <random@developer.example.org>
using your real name (no pseudonyms or anonymous contributions),
you declare the following:
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and
I have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
## Workflow
We appreciate any contributions, so please use the [Forking
Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow)
and send us `Merge Requests`.
### Commit Message
Commit messages shall follow the conventions defined by [conventional
commits](https://www.conventionalcommits.org/en/v1.0.0/).
> **HINT**: A good way to create commit messages is by using the tool `git gui`.
### What to use as scope
In most cases the changed component is a good choice as scope
e.g. if the change is done in the documentation, the scope should be *doc*.
For documentation changes the section that was changed makes a good scope name
e.g. use *FAQ* if you changed that section.
|
