forked from stackitcloud/external-dns-stackit-webhook
-
Notifications
You must be signed in to change notification settings - Fork 1
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
belokobylskii.i
committed
Apr 3, 2024
1 parent
492a8aa
commit 47d3884
Showing
1 changed file
with
34 additions
and
0 deletions.
There are no files selected for viewing
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,34 @@ | ||
# Contributing to External DNS Selectel Webhook | ||
|
||
Welcome and thank you for making it this far and considering contributing to external-dns-selectel-webhook. | ||
We always appreciate any contributions by raising issues, improving the documentation, fixing bugs in the CLI or adding new features. | ||
|
||
Before opening a PR please read through this document. | ||
|
||
## Process of making an addition | ||
|
||
To contribute any code to this repository just do the following: | ||
|
||
1. Make sure you have current Go's version of the project 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/external-dns-selectel-webhook/blob/main/.github/semantic.yml) | ||
> | ||
> An example PR tile for adding a new feature for the CLI would look like: `cli(feat) Add saving output to file` | ||
7. Wait for two of the maintainers to review your code and react to the comments. | ||
8. After two approvals merge the PR | ||
9. Thank you for your contribution! :) |