From 7a2a2251186a7955c84a278ce18aabc0e2ac2840 Mon Sep 17 00:00:00 2001 From: Hector Sanjuan Date: Wed, 29 Apr 2020 13:19:30 +0200 Subject: [PATCH 1/5] Auto-comment on submitted PRs * Give a few tips on linking relevant discussions, self reviews, additional reviews and code contribution guidelines * Be explicit about the next steps and what to expect. --- .github/auto-comment.yml | 43 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 .github/auto-comment.yml diff --git a/.github/auto-comment.yml b/.github/auto-comment.yml new file mode 100644 index 00000000000..3eb71744766 --- /dev/null +++ b/.github/auto-comment.yml @@ -0,0 +1,43 @@ +# Comment to a new issue. +# Disabled +# issueOpened: "" + +pullRequestOpened: > + + Thank you for submitting this PR! + + A maintainer will be here shortly to review it. + + We are super grateful to get code contributions and aim to make the best of + the contribution process. However, we are also overloaded with work, we'd be + happy if you can make sure that: + + * The context for this PR is cleared, with relevant discussion, decisions + and stakeholders linked/mentioned. + + * You have self-reviewed yourself. Please make a self-review and leave + comments providing the rationale behind your changes as needed. Expect + that the person reviewing this code next does not have to be super + familiar with the affected codebase. Follow the [code contribution guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md#code-contribution-guidelines) + when they apply. + + * Getting additional reviews from additional people (community members + etc) is a great help and a great way to pave the way for a quicker + merge. Feel free to ask on the chats or the forums for additional eyes + if your PR is complex. If you are unsure about something, just ask. + + Next steps: + + * A maintainer will triage and assign priority to this PR, commenting on + any missing things and potentially assigning a reviewer for high + priority items. + + * The PR gets reviews, discussed and approvals as needed. + + * The PR is merged by maintainers when it has been approved and comments addressed. + + We currently aim to provide initial feedback/triaging within **two business + days**. Please keep an eye on any labelling actions, as these will indicate + priorities and status of your contribution. + + Again, thank you for contributing! From 04dc11195225c2a59e2b413236b1b8a268e8dbb9 Mon Sep 17 00:00:00 2001 From: Hector Sanjuan Date: Wed, 29 Apr 2020 22:41:39 +0200 Subject: [PATCH 2/5] Update .github/auto-comment.yml Co-Authored-By: Steven Allen --- .github/auto-comment.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/auto-comment.yml b/.github/auto-comment.yml index 3eb71744766..579a6fdd64f 100644 --- a/.github/auto-comment.yml +++ b/.github/auto-comment.yml @@ -12,7 +12,7 @@ pullRequestOpened: > the contribution process. However, we are also overloaded with work, we'd be happy if you can make sure that: - * The context for this PR is cleared, with relevant discussion, decisions + * The context for this PR is clear, with relevant discussion, decisions and stakeholders linked/mentioned. * You have self-reviewed yourself. Please make a self-review and leave From 593d33e217caa547ceef3474912b30d1e8c5330b Mon Sep 17 00:00:00 2001 From: Hector Sanjuan Date: Wed, 29 Apr 2020 22:41:48 +0200 Subject: [PATCH 3/5] Update .github/auto-comment.yml Co-Authored-By: Steven Allen --- .github/auto-comment.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/auto-comment.yml b/.github/auto-comment.yml index 579a6fdd64f..6bca95deb95 100644 --- a/.github/auto-comment.yml +++ b/.github/auto-comment.yml @@ -15,7 +15,7 @@ pullRequestOpened: > * The context for this PR is clear, with relevant discussion, decisions and stakeholders linked/mentioned. - * You have self-reviewed yourself. Please make a self-review and leave + * You have self-reviewed it yourself. Please make a self-review and leave comments providing the rationale behind your changes as needed. Expect that the person reviewing this code next does not have to be super familiar with the affected codebase. Follow the [code contribution guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md#code-contribution-guidelines) From 44b8bdb930a1f033bbb7494cf98c875472a29a8a Mon Sep 17 00:00:00 2001 From: Hector Sanjuan Date: Wed, 29 Apr 2020 22:49:00 +0200 Subject: [PATCH 4/5] Mention that self-review is not a subtitute for code comments --- .github/auto-comment.yml | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/.github/auto-comment.yml b/.github/auto-comment.yml index 6bca95deb95..951419cb2e4 100644 --- a/.github/auto-comment.yml +++ b/.github/auto-comment.yml @@ -16,9 +16,11 @@ pullRequestOpened: > and stakeholders linked/mentioned. * You have self-reviewed it yourself. Please make a self-review and leave - comments providing the rationale behind your changes as needed. Expect - that the person reviewing this code next does not have to be super - familiar with the affected codebase. Follow the [code contribution guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md#code-contribution-guidelines) + comments providing the rationale behind your changes as needed (this is + not a substitute for code comments though!). Expect that the person + reviewing this code next does not have to be super familiar with the + affected codebase. Follow the [code contribution + guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md#code-contribution-guidelines) when they apply. * Getting additional reviews from additional people (community members From a34f927eaffe1186244d6826a21d57851540533d Mon Sep 17 00:00:00 2001 From: Hector Sanjuan Date: Wed, 29 Apr 2020 22:58:30 +0200 Subject: [PATCH 5/5] Shorten --- .github/auto-comment.yml | 23 +++++++++-------------- 1 file changed, 9 insertions(+), 14 deletions(-) diff --git a/.github/auto-comment.yml b/.github/auto-comment.yml index 951419cb2e4..b06ac3be677 100644 --- a/.github/auto-comment.yml +++ b/.github/auto-comment.yml @@ -8,25 +8,20 @@ pullRequestOpened: > A maintainer will be here shortly to review it. - We are super grateful to get code contributions and aim to make the best of - the contribution process. However, we are also overloaded with work, we'd be - happy if you can make sure that: + We are super grateful, but we are also overloaded! Help us by making sure + that: * The context for this PR is clear, with relevant discussion, decisions and stakeholders linked/mentioned. - * You have self-reviewed it yourself. Please make a self-review and leave - comments providing the rationale behind your changes as needed (this is - not a substitute for code comments though!). Expect that the person - reviewing this code next does not have to be super familiar with the - affected codebase. Follow the [code contribution + * Your contribution itself is clear (code comments, self-review for the + rest) and in its best form. Follow the [code contribution guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md#code-contribution-guidelines) - when they apply. + if they apply. - * Getting additional reviews from additional people (community members - etc) is a great help and a great way to pave the way for a quicker - merge. Feel free to ask on the chats or the forums for additional eyes - if your PR is complex. If you are unsure about something, just ask. + Getting other community members to do a review would be great help too on + complex PRs (you can ask in the chats/forums). If you are unsure about + something, just leave us a comment. Next steps: @@ -42,4 +37,4 @@ pullRequestOpened: > days**. Please keep an eye on any labelling actions, as these will indicate priorities and status of your contribution. - Again, thank you for contributing! + We are very grateful for your contribution!