|
| 1 | +# Contributing |
| 2 | + |
| 3 | +The repository is [MIT licensed](https://github.com/swade1987/flux2-kustomize-template/blob/main/LICENSE) and |
| 4 | +accepts contributions via GitHub pull requests. This document outlines |
| 5 | +some of the conventions on to make it easier to get your contribution |
| 6 | +accepted. |
| 7 | + |
| 8 | +We gratefully welcome improvements to issues and documentation as well as to |
| 9 | +code. |
| 10 | + |
| 11 | +## Certificate of Origin |
| 12 | + |
| 13 | +By contributing to the repository you agree to the Developer Certificate of |
| 14 | +Origin (DCO). This document was created by the Linux Kernel community and is a |
| 15 | +simple statement that you, as a contributor, have the legal right to make the |
| 16 | +contribution. |
| 17 | + |
| 18 | +We require all commits to be signed. By signing off with your signature, you |
| 19 | +certify that you wrote the patch or otherwise have the right to contribute the |
| 20 | +material by the rules of the [DCO](DCO): |
| 21 | + |
| 22 | +`Signed-off-by: Jane Doe <[email protected]>` |
| 23 | + |
| 24 | +The signature must contain your real name |
| 25 | +(sorry, no pseudonyms or anonymous contributions) |
| 26 | +If your `user.name` and `user.email` are configured in your Git config, |
| 27 | +you can sign your commit automatically with `git commit -s`. |
| 28 | + |
| 29 | +## Acceptance policy |
| 30 | + |
| 31 | +These things will make a PR more likely to be accepted: |
| 32 | + |
| 33 | +- a well-described requirement |
| 34 | +- sign-off all your commits |
| 35 | +- tests for new configuration |
| 36 | +- tests for old configuration! |
| 37 | + |
| 38 | +In general, we will merge a PR once one maintainer has endorsed it. |
| 39 | +For substantial changes, more people may become involved, and you might |
| 40 | +get asked to resubmit the PR or divide the changes into more than one PR. |
| 41 | + |
| 42 | +### Commit Message and Pull Request Requirements: |
| 43 | + |
| 44 | +This repository enforces the `Conventional Commits` specification for both commit messages and pull request titles. |
| 45 | + |
| 46 | +All commits and PR titles must follow this format: |
| 47 | +type(optional scope): description |
| 48 | + |
| 49 | +Examples: |
| 50 | +- `feat: add new istio validation check` |
| 51 | +- `fix(ci): resolve kubeconform pipeline error` |
| 52 | +- `docs: update deployment instructions` |
| 53 | +- `chore: bump pre-commit hooks version` |
| 54 | + |
| 55 | +The type must be one of: `build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test` |
| 56 | + |
| 57 | +For more details on Conventional Commits, see: https://www.conventionalcommits.org/ |
| 58 | + |
| 59 | +Note: This is enforced automatically via GitHub Actions and pre-commit hooks. |
0 commit comments