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.
Hector Sanjuan committed
Apr 29, 2020 at 13:19 UTC
7a2a2251186a7955c84a278ce18aabc0e2ac2840
1 file changed
+43
.github/auto-comment.yml
new
+43
@@ -0,0 +1,43 @@
1
+# Comment to a new issue.
2
+# Disabled
3
+# issueOpened: ""
4
+
5
+pullRequestOpened: >
6
+
7
+ Thank you for submitting this PR!
8
+
9
+ A maintainer will be here shortly to review it.
10
+
11
+ We are super grateful to get code contributions and aim to make the best of
12
+ the contribution process. However, we are also overloaded with work, we'd be
13
+ happy if you can make sure that:
14
+
15
+ * The context for this PR is cleared, with relevant discussion, decisions
16
+ and stakeholders linked/mentioned.
17
+
18
+ * You have self-reviewed yourself. Please make a self-review and leave
19
+ comments providing the rationale behind your changes as needed. Expect
20
+ that the person reviewing this code next does not have to be super
21
+ familiar with the affected codebase. Follow the [code contribution guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md#code-contribution-guidelines)
22
+ when they apply.
23
+
24
+ * Getting additional reviews from additional people (community members
25
+ etc) is a great help and a great way to pave the way for a quicker
26
+ merge. Feel free to ask on the chats or the forums for additional eyes
27
+ if your PR is complex. If you are unsure about something, just ask.
28
+
29
+ Next steps:
30
+
31
+ * A maintainer will triage and assign priority to this PR, commenting on
32
+ any missing things and potentially assigning a reviewer for high
33
+ priority items.
34
+
35
+ * The PR gets reviews, discussed and approvals as needed.
36
+
37
+ * The PR is merged by maintainers when it has been approved and comments addressed.
38
+
39
+ We currently aim to provide initial feedback/triaging within **two business
40
+ days**. Please keep an eye on any labelling actions, as these will indicate
41
+ priorities and status of your contribution.
42
+
43
+ Again, thank you for contributing!