From f2e4cac2495c21af49bc44e405b4131796afae3e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oliver=20B=C3=A4hler?= Date: Thu, 19 Oct 2023 14:30:17 +0200 Subject: [PATCH] feat(docs): initial contributing draft --- CONTRIBUTING.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 3 +++ 2 files changed, 61 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..03bf8c90 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,58 @@ +# Contributing + +All contributions are welcome! If you find a bug or have a feature request, please open an issue or submit a pull request. + + +## Guidelines + + +## Pull Requests + + +## Commits + +Commit messages should indicate the change and it's impact. The general format for commit messages is the following: + + feat(ui): Add `Button` component + ^ ^ ^ + | | |__ Subject + | |_______ Scope + |____________ Type + + The commits are checked on pull-request. If the commit message does not follow the format, the workflow will fail. See the [Types](#types) and [Scopes](#scopes) sections for more information. + +## Types + +The following types are allowed for commits and pull requests: + + * `ci` or `build`: changes to buillding process/workflows + * `docs`: changes to documentation + * `feat`: new features + * `fix`: bug fixes + +## Scopes + +The following types are allowed for commits and pull requests: + + * `all`: changes that affect all components + * `chart`: changes to the Helm chart + * `operator`: changes to the operator + * `docs`: changes to the documentation + * `website`: changes to the website + * `ci`: changes to the CI/CD workflows + * `build`: changes to the build process + * `test`: changes to the testing process + * `release`: changes to the release process + * `deps`: dependency updates + +### Sign-Off + +Developer Certificate of Origin (DCO) Sign off +For contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project, we are requiring everyone to acknowledge this by signing their work which indicates you agree to the DCO found here. + +To sign your work, just add a line like this at the end of your commit message: + +Signed-off-by: Random J Developer +This can easily be done with the -s command line option to append this automatically to your commit message. + +git commit -s -m 'This is my commit message' diff --git a/README.md b/README.md index 7f28e7bf..012e325b 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,9 @@ + + +