From 933750be6934a2de6275708376757fc307a789b1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Astori?= Date: Sat, 26 Sep 2015 15:41:16 +0000 Subject: [PATCH 1/8] Add a small introduction to the CONTRIBUTING file --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..17928fb1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,4 @@ +## Contributing + +Welcome to the Shout community, it's great to have you here! We thank you in +advance for your contributions. From 5aae711bc68636f1a53949c012cad90e78fb50fe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Astori?= Date: Sat, 26 Sep 2015 15:41:42 +0000 Subject: [PATCH 2/8] Add label explanation to the CONTRIBUTING file --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 17928fb1..887f1347 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,3 +2,25 @@ Welcome to the Shout community, it's great to have you here! We thank you in advance for your contributions. + +### Labels + +When you open an [issue](https://github.com/erming/shout/issues) or send us a +[PR](https://github.com/erming/shout/pulls), it will most likely be given one or +several labels. Here is what they mean: + +- **bug**: Issues that report and PRs that solve any defects that cause + unexpected behaviors. +- **documentation**: Tickets that mention a lack of documentation, suggest their + improvement, or PRs that address these. +- **duplicate**: Tickets already solved in the past or already open. Such + tickets should always link to the previous one on the subject. +- **enhancement**: Tickets that describe a desired feature or PRs that add them + to the project. +- **help wanted**: Tickets that we would like the community to help us with, by + either answering questions or send us PRs. +- **priority**: Tickets that the core team deemed critical and PRs that the core + team should look at before others. +- **question**: Tickets that are actually support cases. +- **wontfix**: Tickets that, after discussion and explanation, will not be fixed + or implemented. From 96d500c2a98948d3cb5c741d2212b23413b45d7b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Astori?= Date: Tue, 6 Oct 2015 04:20:59 +0000 Subject: [PATCH 3/8] Add descriptions for 2 new labels: quick and easy, and security --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 887f1347..b78b2a06 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,5 +22,9 @@ several labels. Here is what they mean: - **priority**: Tickets that the core team deemed critical and PRs that the core team should look at before others. - **question**: Tickets that are actually support cases. +- **quick and easy**: Tickets that should be fairly simple to implement, even + for developers not yet involved in the project. +- **security**: Tickets that describe a security concern or PRs that must be + reviewed with extra care regarding security. - **wontfix**: Tickets that, after discussion and explanation, will not be fixed or implemented. From 201938cd710ac91e437e663f7baff71133c55e29 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Astori?= Date: Wed, 7 Oct 2015 03:14:20 +0000 Subject: [PATCH 4/8] Add CONTRIBUTING paragraphs on questions, issues and PRs --- CONTRIBUTING.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b78b2a06..4cc25ee2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,6 +3,48 @@ Welcome to the Shout community, it's great to have you here! We thank you in advance for your contributions. +### I have a question + +Find us on the #shout-irc channel. You might not get an answer right away, but +this channel is filled with nice people who will be happy to help you. + +### I want to report a bug + +First of all, look at the +[open issues](https://github.com/erming/shout/issues) and [closed +issues](https://github.com/erming/shout/issues?q=is%3Aissue+is%3Aclosed) +to see if this was not alredy discussed before. + +### I want to contribute to the code + +A good starting point if you want to help us but do not have a clear idea of +what you can do specifically is to +look at the open issues labeled as [*quick and +easy*](https://github.com/erming/shout/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3A%22quick+and+easy%22) +or [*help +wanted*](https://github.com/erming/shout/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3A%22help+wanted%22). + +When you submit some code, make sure it respects the overall coding style that +is currently in place. If you do not, our reviewers will surely let you know you +should :smile: (that is, until an automated checker takes over the yelling). + +Also, make sure that your PRs do not contain unnecessary commits. If you think +some of your commits should be merged into a single one, feel free to [squash +them](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History). + +Additionally, give extra care to your commit messages, as they will help us +review your PRs as well as help other contributors in the future, when exploring +the history. The general rules are to [use the imperative present +tense](https://git-scm.com/book/ch5-2.html#Commit-Guidelines), to start with a +single concise line, followed by a blank line and a more detailed explanation +when necessary. Tim Pope wrote an [excellent +article](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) +on how one should format their commit messages. + +When you send your PR, expect two different reviews from the project +maintainers. They will make comments and give their respective :+1: before your +changes can go into production. + ### Labels When you open an [issue](https://github.com/erming/shout/issues) or send us a From 9de191c8a4d81f9418b2213e66055b2b0f754446 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Astori?= Date: Wed, 7 Oct 2015 03:22:22 +0000 Subject: [PATCH 5/8] Add second review needed label to the CONTRIBUTING label description --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4cc25ee2..d8fe5851 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -66,6 +66,8 @@ several labels. Here is what they mean: - **question**: Tickets that are actually support cases. - **quick and easy**: Tickets that should be fairly simple to implement, even for developers not yet involved in the project. +- **second review needed**: A first reviewer gave his :+1: but now expects a + second reviewer to step in before this PR can be merged. - **security**: Tickets that describe a security concern or PRs that must be reviewed with extra care regarding security. - **wontfix**: Tickets that, after discussion and explanation, will not be fixed From 9afa0ce2d11f36a68a51fe7447c6191357844148 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Astori?= Date: Wed, 7 Oct 2015 03:30:53 +0000 Subject: [PATCH 6/8] Add a paragraph on documentation Taken from #358 --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d8fe5851..b1d557a3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -45,6 +45,9 @@ When you send your PR, expect two different reviews from the project maintainers. They will make comments and give their respective :+1: before your changes can go into production. +Please document any relevant changes in the shout documentation that can be +found [in its own repository](https://github.com/erming/shout-website). + ### Labels When you open an [issue](https://github.com/erming/shout/issues) or send us a From 1671858e9c89e057e2e8e9e48b7111747ed9b3a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Astori?= Date: Thu, 8 Oct 2015 03:58:26 +0000 Subject: [PATCH 7/8] Be more explicit on the process workflow in the CONTRIBUTING file --- CONTRIBUTING.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b1d557a3..4128ffb1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,9 +41,13 @@ when necessary. Tim Pope wrote an [excellent article](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) on how one should format their commit messages. -When you send your PR, expect two different reviews from the project -maintainers. They will make comments and give their respective :+1: before your -changes can go into production. +When you send a PR, expect two different reviews from the project maintainers. +If necessary, they will make comments and ask for changes. When everything looks +good to them, they will both express their consent by commenting your PR with a +:+1:. Typically, the first reviewer will give a thorough report and exchange +with you, give his :+1:, then ask the second reviewer to confirm the changes. +When this happens (when you get your second required :+1:), then your PR can be +merged. Please document any relevant changes in the shout documentation that can be found [in its own repository](https://github.com/erming/shout-website). From 9f7f0f74fb19e2a1330661929a288bb30cb84ad3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Astori?= Date: Sat, 10 Oct 2015 00:52:02 +0000 Subject: [PATCH 8/8] List project maintainers in the CONTRIBUTING file --- CONTRIBUTING.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4128ffb1..a07788aa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,7 +41,8 @@ when necessary. Tim Pope wrote an [excellent article](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) on how one should format their commit messages. -When you send a PR, expect two different reviews from the project maintainers. +When you send a PR, expect two different reviews from the [project +maintainers](https://github.com/erming/shout/blob/master/CONTRIBUTING.md#project-maintainers). If necessary, they will make comments and ask for changes. When everything looks good to them, they will both express their consent by commenting your PR with a :+1:. Typically, the first reviewer will give a thorough report and exchange @@ -79,3 +80,9 @@ several labels. Here is what they mean: reviewed with extra care regarding security. - **wontfix**: Tickets that, after discussion and explanation, will not be fixed or implemented. + +### Project maintainers + +- [Mattias Erming](https://github.com/erming) (`erming` on IRC) +- [Jocelyn Delalande](https://github.com/JocelynDelalande) (`JocelynD` on IRC) +- [Jérémie Astori](https://github.com/astorije) (`astorije` on IRC)