From 3995db446a538d2b090cae67fef8b003c2511437 Mon Sep 17 00:00:00 2001 From: Augustin Mauroy <97875033+AugustinMauroy@users.noreply.github.com> Date: Wed, 25 Jan 2023 21:37:21 +0100 Subject: [PATCH 1/7] Chore(contributing): introduce contribution guideline --- CONTRIBUTING.MD | 81 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 CONTRIBUTING.MD diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD new file mode 100644 index 00000000..f7825e04 --- /dev/null +++ b/CONTRIBUTING.MD @@ -0,0 +1,81 @@ +# Contributing guide + +Thanks for your contribution 🥳 to the Fastily website redesign project! + +[Code of Conduct](https://github.com/fastify/.github/blob/main/CODE_OF_CONDUCT.md) + +* [Vocabulary](#vocabulary) +* [📝 Commit message guidelines](#-commit-message-guidelines) +* [📜 Pull Request Policy](#-pull-request-policy) +* [Before merging](#before-merging) +* [When merging](#when-merging) +* [Becoming a collaborator](#becoming-a-collaborator) +* [🐛 Debugging failing checks](#-debugging-failing-checks) +* [Developer's Certificate of Origin 1.1](#developers-certificate-of-origin-11) + +## 📝 Commit message guidelines + +This project follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. + +Basic rules: + +Supported subsystems: +> build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test + +* Commit messages **must** start with a capital letter + +* Commit messages **must not** end with a period `.` + +## 📜 Pull Request Policy + +### Before merging + +* Pull Requests must be open for at least 12 hours. + * Pull requests might be immediately merged if they contain critical bug fixes, short erratas (e.g. typos from previous PRs) or any critical change that is considered a "showstopper" for the operation of the website. + * These kind of PRs should only be done by existing collaborators that have write-access and/or signed-off by administrators/maintainers. +* There must be no objections after a 24 hour period +* Fast track is allowed for collaborators. + +Each contribution is accepted only if there is no objection to it by a collaborator. During the review, collaborators may request that a specific contributor who is an expert in a particular area give an "LGTM" (looks good to me) before the PR can be merged. + +In the case that an objection is raised in a pull request by another collaborator, all collaborators involved should try to arrive at a consensus by addressing the concerns through discussion, compromise, or withdrawal of the proposed change(s). + +### When merging + +* `squash` pull requests made up of multiple commits + +## Vocabulary + +* A **Contributor** is any individual who creates an issue/PR, comments on an issue/PR + or contributes in some other way. +* A **Collaborator** is a contributor with write access to the repository. See [here](#becoming-a-collaborator) on how to become a collaborator. + +## Becoming a collaborator + + + +## 🐛 Debugging failing checks + +* For failing formatting or linting, try running: + +```bash +npm run format +``` + +## Developer's Certificate of Origin 1.1 + +By contributing to this project, I certify that: + +* (a) The contribution was created in whole or in part by me and I have the right to + submit it under the open source license indicated in the file; or +* (b) The contribution is based upon previous work that, to the best of my knowledge, + is covered under an appropriate open source license and I have the right under that + license to submit that work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am permitted to submit under a + different license), as indicated in the file; or +* (c) The contribution was provided directly to me by some other person who certified + (a), (b) or (c) and I have not modified it. +* (d) I understand and agree that this project and the contribution are public and that + a record of the contribution (including all personal information I submit with it, + including my sign-off) is maintained indefinitely and may be redistributed consistent + with this project or the open source license(s) involved. From 69abf77e448b4ac8382a25f4274f5538b703ecb3 Mon Sep 17 00:00:00 2001 From: Augustin Mauroy <97875033+AugustinMauroy@users.noreply.github.com> Date: Thu, 26 Jan 2023 10:10:39 +0100 Subject: [PATCH 2/7] Update CONTRIBUTING.MD Co-authored-by: Manuel Spigolon --- CONTRIBUTING.MD | 3 --- 1 file changed, 3 deletions(-) diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD index f7825e04..a29cc96d 100644 --- a/CONTRIBUTING.MD +++ b/CONTRIBUTING.MD @@ -40,9 +40,6 @@ Each contribution is accepted only if there is no objection to it by a collabora In the case that an objection is raised in a pull request by another collaborator, all collaborators involved should try to arrive at a consensus by addressing the concerns through discussion, compromise, or withdrawal of the proposed change(s). -### When merging - -* `squash` pull requests made up of multiple commits ## Vocabulary From 8a3f9872c422e47c2b1d77739373a6fcd37c6fcf Mon Sep 17 00:00:00 2001 From: Augustin Mauroy <97875033+AugustinMauroy@users.noreply.github.com> Date: Thu, 26 Jan 2023 10:11:41 +0100 Subject: [PATCH 3/7] Update CONTRIBUTING.MD Co-authored-by: Manuel Spigolon --- CONTRIBUTING.MD | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD index a29cc96d..da05344e 100644 --- a/CONTRIBUTING.MD +++ b/CONTRIBUTING.MD @@ -49,7 +49,7 @@ In the case that an objection is raised in a pull request by another collaborato ## Becoming a collaborator - +We follow the [Fastify organization Governance model](https://github.com/fastify/fastify/blob/main/GOVERNANCE.md#collaborator-nominations) so it is necessary to contribute to this repository in order to become a member. ## 🐛 Debugging failing checks From 75e2f6a8082594f1de7400310f6b4bd77aefe1b4 Mon Sep 17 00:00:00 2001 From: Augustin Mauroy <97875033+AugustinMauroy@users.noreply.github.com> Date: Thu, 26 Jan 2023 10:21:54 +0100 Subject: [PATCH 4/7] chore(contribution): update section "Commit message guidelines" --- CONTRIBUTING.MD | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD index da05344e..35c744e5 100644 --- a/CONTRIBUTING.MD +++ b/CONTRIBUTING.MD @@ -22,9 +22,7 @@ Basic rules: Supported subsystems: > build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test -* Commit messages **must** start with a capital letter - -* Commit messages **must not** end with a period `.` +Try to start the commit message with a capital letter. And try to avoid ending it with a period `.`. ## 📜 Pull Request Policy From f96bf172017d2ac7c01acebb5af292fc29d90500 Mon Sep 17 00:00:00 2001 From: Augustin Mauroy <97875033+AugustinMauroy@users.noreply.github.com> Date: Sat, 11 Feb 2023 15:03:33 +0100 Subject: [PATCH 5/7] chore(guideline): update the content --- CONTRIBUTING.MD | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD index 35c744e5..33e15aac 100644 --- a/CONTRIBUTING.MD +++ b/CONTRIBUTING.MD @@ -5,15 +5,14 @@ Thanks for your contribution 🥳 to the Fastily website redesign project! [Code of Conduct](https://github.com/fastify/.github/blob/main/CODE_OF_CONDUCT.md) * [Vocabulary](#vocabulary) -* [📝 Commit message guidelines](#-commit-message-guidelines) -* [📜 Pull Request Policy](#-pull-request-policy) +* [Commit message guidelines](#commit-message-guidelines) +* [Pull Request Policy](#pull-request-policy) * [Before merging](#before-merging) -* [When merging](#when-merging) * [Becoming a collaborator](#becoming-a-collaborator) -* [🐛 Debugging failing checks](#-debugging-failing-checks) +* [Debugging failing checks](#debugging-failing-checks) * [Developer's Certificate of Origin 1.1](#developers-certificate-of-origin-11) -## 📝 Commit message guidelines +## Commit message guidelines This project follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. @@ -24,7 +23,7 @@ Supported subsystems: Try to start the commit message with a capital letter. And try to avoid ending it with a period `.`. -## 📜 Pull Request Policy +## Pull Request Policy ### Before merging @@ -38,7 +37,6 @@ Each contribution is accepted only if there is no objection to it by a collabora In the case that an objection is raised in a pull request by another collaborator, all collaborators involved should try to arrive at a consensus by addressing the concerns through discussion, compromise, or withdrawal of the proposed change(s). - ## Vocabulary * A **Contributor** is any individual who creates an issue/PR, comments on an issue/PR @@ -49,7 +47,7 @@ In the case that an objection is raised in a pull request by another collaborato We follow the [Fastify organization Governance model](https://github.com/fastify/fastify/blob/main/GOVERNANCE.md#collaborator-nominations) so it is necessary to contribute to this repository in order to become a member. -## 🐛 Debugging failing checks +## Debugging failing checks * For failing formatting or linting, try running: From a225eac99c2d908695dbbaec5fedb70c28c5d1d1 Mon Sep 17 00:00:00 2001 From: Augustin Mauroy <97875033+AugustinMauroy@users.noreply.github.com> Date: Sat, 25 Feb 2023 23:46:00 +0100 Subject: [PATCH 6/7] Update CONTRIBUTING.MD Co-authored-by: Manuel Spigolon --- CONTRIBUTING.MD | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD index 33e15aac..9fc874cf 100644 --- a/CONTRIBUTING.MD +++ b/CONTRIBUTING.MD @@ -27,15 +27,7 @@ Try to start the commit message with a capital letter. And try to avoid ending i ### Before merging -* Pull Requests must be open for at least 12 hours. - * Pull requests might be immediately merged if they contain critical bug fixes, short erratas (e.g. typos from previous PRs) or any critical change that is considered a "showstopper" for the operation of the website. - * These kind of PRs should only be done by existing collaborators that have write-access and/or signed-off by administrators/maintainers. -* There must be no objections after a 24 hour period -* Fast track is allowed for collaborators. - -Each contribution is accepted only if there is no objection to it by a collaborator. During the review, collaborators may request that a specific contributor who is an expert in a particular area give an "LGTM" (looks good to me) before the PR can be merged. - -In the case that an objection is raised in a pull request by another collaborator, all collaborators involved should try to arrive at a consensus by addressing the concerns through discussion, compromise, or withdrawal of the proposed change(s). +This repository follows the same rules as a fastify plugin repository. A detailed process is explained at [fastify/CONTRIBUTING.md#rules](https://github.com/fastify/fastify/blob/main/CONTRIBUTING.md#rules) ## Vocabulary From 6813104dc9f66edfdef38078f9537a63d81ef5ca Mon Sep 17 00:00:00 2001 From: Augustin Mauroy <97875033+AugustinMauroy@users.noreply.github.com> Date: Sat, 25 Feb 2023 23:46:06 +0100 Subject: [PATCH 7/7] Update CONTRIBUTING.MD Co-authored-by: Manuel Spigolon --- CONTRIBUTING.MD | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD index 9fc874cf..d894b38e 100644 --- a/CONTRIBUTING.MD +++ b/CONTRIBUTING.MD @@ -12,16 +12,6 @@ Thanks for your contribution 🥳 to the Fastily website redesign project! * [Debugging failing checks](#debugging-failing-checks) * [Developer's Certificate of Origin 1.1](#developers-certificate-of-origin-11) -## Commit message guidelines - -This project follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. - -Basic rules: - -Supported subsystems: -> build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test - -Try to start the commit message with a capital letter. And try to avoid ending it with a period `.`. ## Pull Request Policy