-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Patrick Koss
committed
Sep 14, 2023
1 parent
f1278dd
commit 1ef2a5e
Showing
3 changed files
with
46 additions
and
0 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* patrick.koss@mail.schwarz marius.galm@mail.schwarz simon.stier@mail.schwarz |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Contributing to Certbot DNS-STACKIT Authenticator Plugin | ||
|
||
Welcome and thank you for making it this far and considering contributing to certbot-dns-stackit. | ||
We always appreciate any contributions by raising issues, improving the documentation, fixing bugs or adding new | ||
features. | ||
|
||
Before opening a PR please read through this document. | ||
If you want to contribute but don't know how to start or have any questions feel free to reach out to us | ||
on [Github Discussions](https://github.com/stackitcloud/certbot-dns-stackit/discussions). Answering any questions or | ||
discussions there is also a great way to contribute to the community. | ||
|
||
## Process of making an addition | ||
|
||
> Please keep in mind to open an issue whenever you plan to make an addition to features to discuss it before | ||
> implementing it. | ||
To contribute any code to this repository just do the following: | ||
|
||
1. Make sure you have Go's latest version installed | ||
2. Fork this repository | ||
3. Run `make build` to make sure everything's setup correctly | ||
4. Make your changes | ||
> Please follow the [seven rules of greate Git commit messages](https://chris.beams.io/posts/git-commit/#seven-rules) | ||
> and make sure to keep your commits clean and atomic. | ||
> Your PR won't be squashed before merging so the commits should tell a story. | ||
> | ||
> Optional: Sign-off on all Git commits by running `git commit -s`. | ||
> Take a look at | ||
the [Gihub Docs](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) | ||
for further information. | ||
> | ||
> Add documentation and tests for your addition if needed. | ||
5. Run `make lint test` to ensure your code is ready to be merged | ||
> If any linting issues occur please fix them. | ||
> Using a nolint directive should only be used as a last resort. | ||
6. Open a PR and make sure the CI pipelines succeed. | ||
> Your PR needs to have a semantic title, which can look like: `type(scope) Short Description` | ||
> All available `scopes` & `types` are defined | ||
in [semantic.yml](https://github.com/stackitcloud/certbot-dns-stackit/blob/main/.github/semantic.yml) | ||
7. Wait for one of the maintainers to review your code and react to the comments. | ||
8. After approval merge the PR | ||
9. Thank you for your contribution! :) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,3 +18,6 @@ setup-venv: | |
.PHONY: venv | ||
venv: setup-venv | ||
$(VENV_PATH)/bin/pip install -e . | ||
|
||
.PHONY: build | ||
build: venv |