From e0910322798aef1504e3ff9f877cd2b0555f4540 Mon Sep 17 00:00:00 2001 From: Amir Zarrinkafsh Date: Sat, 30 Jan 2021 19:29:07 +1100 Subject: [PATCH] docs: update contribution guidelines (#1666) * docs: update contribution guidelines * add release commit message type * update none/empty scope definition * add go mod tidy post update option --- .renovaterc | 5 +- CONTRIBUTING.md | 57 +++++++- README.md | 6 +- SECURITY.md | 10 +- docs/contributing/authelia-scripts.md | 1 + docs/contributing/build-and-dev.md | 4 +- docs/contributing/commitmsg-guidelines.md | 154 ++++++++++++++++++++++ docs/contributing/index.md | 9 +- 8 files changed, 224 insertions(+), 22 deletions(-) create mode 100644 docs/contributing/commitmsg-guidelines.md diff --git a/.renovaterc b/.renovaterc index fcfb1a413..2f26b95c5 100644 --- a/.renovaterc +++ b/.renovaterc @@ -1,7 +1,7 @@ { "extends": [ "config:base", - ":semanticCommitTypeAll(chore)", + ":semanticCommitTypeAll(build)", ":separatePatchReleases" ], "ignorePresets": [ @@ -54,5 +54,8 @@ ] } ], + "postUpdateOptions": [ + "gomodTidy" + ], "rebaseWhen": "never" } \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7b406fabf..dc0eb59ff 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,54 @@ # Contributing -Anybody willing to contribute to the project either with code, -documentation, security reviews or whatever, are very welcome to create -or review pull requests and take part to discussions in our public chatroom -on [Matrix](https://riot.im/app/#/room/#authelia:matrix.org). +Anybody willing to contribute to the project either with code, documentation, security reviews or whatever, are very welcome to create or review pull requests and take part to discussions in our public chatroom on [Matrix](https://riot.im/app/#/room/#authelia:matrix.org). -It's also possible to contribute financially in order to support the -community. +It's also possible to contribute financially in order to support the community. -Don't hesitate to come help us improve Authelia! See you soon! \ No newline at end of file +Don't hesitate to come help us improve Authelia! See you soon! + +## Bug Reports and Feature Requests + +If you've found a **bug** or have a **feature request** then please create an issue in this repository (but search first in case a similar issue already exists). + +## Code + +If you would like to fix a bug or implement a feature, please fork the repository and create a Pull Request. +More information on getting set up locally can be found [here](https://www.authelia.com/docs/contributing/). + +Before you start any Pull Request, it's recommended that you create an issue to discuss first if you have any doubts about requirement or implementation. +That way you can be sure that the maintainer(s) agree on what to change and how, and you can hopefully get a quick merge afterwards. +Also, let the maintainers know that you plan to work on a particular issue so that no one else starts any duplicate work. + +Pull Requests can only be merged once all status checks are green, which means `authelia-scripts --log-level debug ci` passes, and coverage does not regress. + +## Do not force push to your pull request branch + +Please do not force push to your PR's branch after you have created your PR, as doing so makes it harder for us to review your work. +PRs will always be squashed by us when we merge your work. +Commit as many times as you need in your pull request branch. + +## Re-requesting a review + +Please do not ping your reviewer(s) by mentioning them in a new comment. +Instead, use the re-request review functionality. +Read more about this in the [GitHub docs, Re-requesting a review](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request#re-requesting-a-review). + +## Collaboration with maintainers + +Sometimes the codebase can be a challenge to navigate, especially for a first-time contributor. +We don't want you spending an hour trying to work out something that would take us only a minute to explain. + +For that reason, we have [Matrix](#matrix) and [Discord](#discord) channels dedicated to helping anyone who's working on Pull Requests for Authelia. + +## Contact Options + +### Matrix + +Join the [Matrix Room](https://riot.im/app/#/room/#authelia:matrix.org) and locate one of the maintainers. +You can identify them as they are the room administrators. Alternatively you can just ask for one of the +maintainers. + +### Discord + +Join the [Discord Server](https://discord.authelia.com) and message the +[#contributing](https://discord.com/channels/707844280412012608/804943261265297408) chat and contact a maintainer. \ No newline at end of file diff --git a/README.md b/README.md index 0595969b5..a70d85388 100644 --- a/README.md +++ b/README.md @@ -152,11 +152,9 @@ Internet (your reverse proxies are) however, it's still the control plane for yo ## Contribute -If you want to contribute to Authelia, check the documentation available -[here](https://docs.authelia.com/contributing/). +If you want to contribute to Authelia, please read our [contribution guidelines](./CONTRIBUTING.md). -Authelia exists thanks to all the people who contribute so don't be shy, -come chat with us on [Matrix](#matrix) and start [contributing](./CONTRIBUTING.md) too. +Authelia exists thanks to all the people who contribute so don't be shy, come chat with us on [Matrix](#matrix) and start contributing too. Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): diff --git a/SECURITY.md b/SECURITY.md index ccd638249..342af0bfe 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -19,9 +19,15 @@ Join the [Matrix Room](https://riot.im/app/#/room/#authelia:matrix.org) and loca You can identify them as they are the room administrators. Alternatively you can just ask for one of the maintainers. Once you've made contact we ask you privately message the maintainer to communicate the vulnerability. +### Discord + +Join the [Discord Server](https://discord.authelia.com) and message the +[#support](https://discord.com/channels/707844280412012608/707844280412012612) chat which links to [Matrix](#matrix) +and contact a maintainer. + ### Email -You can contact any of the maintainers for security vulnerability related issues by emailing +You can contact any of the maintainers for security vulnerability related issues by emailing [security@authelia.com](mailto:security@authelia.com). This email is strictly reserved for security and vulnerability disclosure related matters. If you need to contact us for another reason please use [Matrix](#matrix) or -[team@authelia.com](mailto:security@authelia.com). \ No newline at end of file +[team@authelia.com](mailto:team@authelia.com). \ No newline at end of file diff --git a/docs/contributing/authelia-scripts.md b/docs/contributing/authelia-scripts.md index 3bb5e893d..fed4a0a81 100644 --- a/docs/contributing/authelia-scripts.md +++ b/docs/contributing/authelia-scripts.md @@ -2,6 +2,7 @@ layout: default title: Authelia Scripts parent: Contributing +nav_order: 2 --- # Authelia Scripts diff --git a/docs/contributing/build-and-dev.md b/docs/contributing/build-and-dev.md index ba6bacca8..435a6a350 100644 --- a/docs/contributing/build-and-dev.md +++ b/docs/contributing/build-and-dev.md @@ -13,7 +13,7 @@ running `source bootstrap.sh`. This CLI provides many useful tools to help you during development. In order to build and contribute to **Authelia**, you need to make -sure Go v1.13, Docker, docker-compose and Node v12 are installed on +sure Go >= v1.13, Docker, docker-compose and Node >= v12 are installed on your machine. ## Get started @@ -84,7 +84,7 @@ test the *Standalone* suite. $ authelia-scripts suites test Standalone The suite will be spawned, tests will be run and then the suite -will be teared down automatically. +will be torn down automatically. [suites]: ./suites.md diff --git a/docs/contributing/commitmsg-guidelines.md b/docs/contributing/commitmsg-guidelines.md new file mode 100644 index 000000000..d5852d4a8 --- /dev/null +++ b/docs/contributing/commitmsg-guidelines.md @@ -0,0 +1,154 @@ +--- +layout: default +title: Commit Message Guidelines +parent: Contributing +nav_order: 3 +--- + +# Commit Message Guidelines + +## The reasons for these conventions: + +- simple navigation though and easier to read git history + +## Format of the commit message: + +Each commit message consists of a **header**, a **body**, and a **footer**. + +```bash +
+ + + +