Skip to content

Commit dbbd5bc

Browse files
Merge pull request #8 from scality/add-contributing
feat: Add CONTRIBUTING.md
2 parents 0aeff96 + 098884c commit dbbd5bc

1 file changed

Lines changed: 61 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Contributing to the Project
2+
3+
This document contains and defines the rules that have to be followed by any
4+
contributor to the project, in order for any change to be merged into the
5+
stable branches.
6+
7+
## Workflow Guidelines
8+
9+
### Committing Guidelines
10+
11+
No restrictions are placed at this time on individual commits passing in the
12+
CI and/or maintaining full functionality of the repository.
13+
14+
Commit messages should:
15+
16+
* have a short (< 50 characters) summary as title
17+
* contain more explanations, if necessary, in the body
18+
* contain a reference to the issue being tackled in the body
19+
20+
A commit message should *not* contain a reference to the issue in the title.
21+
22+
### Pull Request Guidelines
23+
24+
Pull requests should contain in their body a reference to the GitHub issue
25+
being targeted by the changeset introduced.
26+
27+
### Signing your work
28+
29+
In order to contribute to the project, you must sign your work. By signing your
30+
work, you certify to the statements set out in the Developer Certificate of
31+
Origin ([developercertificate.org](https://developercertificate.org/))
32+
33+
Signing your work is easy. Just add the following line at the end of each of
34+
your commit messages. You must use your real name in your sign-off.
35+
36+
```
37+
Signed-off-by: Jane Doe <jane.doe@email.com>
38+
```
39+
40+
If your `user.name` and `user.email` are set in your git configs, you can sign
41+
each commit automatically by using the `git commit -s` command.
42+
43+
## Reporting an issue
44+
45+
This project uses Github issues to manage the issues.
46+
47+
Before creating an issue:
48+
49+
1. upgrade the operator to the latest supported release version, and check whether your bug is still present,
50+
2. ensure the operator version is supported by the PowerDNS version you are using,
51+
3. have a look in the opened issues if your problem is already known/tracked, and possibly contribute to the thread with your own information.
52+
53+
If none of the above was met, open an issue directly in Github, select the appropriate issue template and fill-in each section when applicable.
54+
55+
## Testing & Linting
56+
57+
Run tests and lint the code:
58+
```go
59+
go test -v ./...
60+
golangci-lint run
61+
```

0 commit comments

Comments
 (0)