Skip to content

Commit 1ef2a5e

Browse files
author
Patrick Koss
committed
add github stuff
1 parent f1278dd commit 1ef2a5e

File tree

3 files changed

+46
-0
lines changed

3 files changed

+46
-0
lines changed

CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing to Certbot DNS-STACKIT Authenticator Plugin
2+
3+
Welcome and thank you for making it this far and considering contributing to certbot-dns-stackit.
4+
We always appreciate any contributions by raising issues, improving the documentation, fixing bugs or adding new
5+
features.
6+
7+
Before opening a PR please read through this document.
8+
If you want to contribute but don't know how to start or have any questions feel free to reach out to us
9+
on [Github Discussions](https://github.com/stackitcloud/certbot-dns-stackit/discussions). Answering any questions or
10+
discussions there is also a great way to contribute to the community.
11+
12+
## Process of making an addition
13+
14+
> Please keep in mind to open an issue whenever you plan to make an addition to features to discuss it before
15+
> implementing it.
16+
17+
To contribute any code to this repository just do the following:
18+
19+
1. Make sure you have Go's latest version installed
20+
2. Fork this repository
21+
3. Run `make build` to make sure everything's setup correctly
22+
4. Make your changes
23+
> Please follow the [seven rules of greate Git commit messages](https://chris.beams.io/posts/git-commit/#seven-rules)
24+
> and make sure to keep your commits clean and atomic.
25+
> Your PR won't be squashed before merging so the commits should tell a story.
26+
>
27+
> Optional: Sign-off on all Git commits by running `git commit -s`.
28+
> Take a look at
29+
the [Gihub Docs](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits)
30+
for further information.
31+
>
32+
> Add documentation and tests for your addition if needed.
33+
5. Run `make lint test` to ensure your code is ready to be merged
34+
> If any linting issues occur please fix them.
35+
> Using a nolint directive should only be used as a last resort.
36+
6. Open a PR and make sure the CI pipelines succeed.
37+
> Your PR needs to have a semantic title, which can look like: `type(scope) Short Description`
38+
> All available `scopes` & `types` are defined
39+
in [semantic.yml](https://github.com/stackitcloud/certbot-dns-stackit/blob/main/.github/semantic.yml)
40+
7. Wait for one of the maintainers to review your code and react to the comments.
41+
8. After approval merge the PR
42+
9. Thank you for your contribution! :)

Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,6 @@ setup-venv:
1818
.PHONY: venv
1919
venv: setup-venv
2020
$(VENV_PATH)/bin/pip install -e .
21+
22+
.PHONY: build
23+
build: venv

0 commit comments

Comments
 (0)