Skip to content

Commit 667d11b

Browse files
Added required Contributor Guidelines checkbox to all issues and PR templates (#1608)
1 parent a7d1cba commit 667d11b

File tree

7 files changed

+79
-16
lines changed

7 files changed

+79
-16
lines changed

.github/ISSUE_TEMPLATE/#2PlaysAMonth.yml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,15 @@ description: 'Add a new Play entry for the #2PlaysAMonth event.'
33
title: '[#2PlaysAMonth]: '
44
labels: ['#2PlaysAMonth']
55
body:
6+
- type: checkboxes
7+
id: read-guidelines
8+
attributes:
9+
label: Contributor Guidelines
10+
description: Please confirm that you have read the [Contributor Guidelines and Discussion](https://github.com/reactplay/react-play/discussions/1598) before submitting this issue or PR.
11+
options:
12+
- label: I have read the guidelines and discussion
13+
required: true
14+
615
- type: markdown
716
attributes:
817
value: |
@@ -36,7 +45,6 @@ body:
3645
- label: I want to work on this issue
3746
- label: I am a Hacktoberfest contributor
3847

39-
4048
- type: checkboxes
4149
id: terms
4250
attributes:

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
1-
name: "\U0001F41B [Bug report]:"
1+
name: "🐛 [Bug report]:"
22
description: Create a report to help us improve
3-
title: "\U0001F41B [Bug report]: "
4-
labels: ["bug","🛠 goal: fix", "🚦status: awaiting triage", "💻 aspect: code"]
3+
title: "🐛 [Bug report]: "
4+
labels: ["bug", "🛠 goal: fix", "🚦status: awaiting triage", "💻 aspect: code"]
55
body:
6+
- type: checkboxes
7+
id: read-guidelines
8+
attributes:
9+
label: Contributor Guidelines
10+
description: Please confirm that you have read the [Contributor Guidelines and Discussion](https://github.com/reactplay/react-play/discussions/1598) before submitting this issue or PR.
11+
options:
12+
- label: I have read the guidelines and discussion
13+
required: true
14+
615
- type: markdown
716
attributes:
817
value: |
@@ -15,6 +24,7 @@ body:
1524
description: Tell us what you see!
1625
validations:
1726
required: true
27+
1828
- type: textarea
1929
id: reproduce-step
2030
attributes:
@@ -54,10 +64,11 @@ body:
5464
label: Mobile (Please provide your device information)
5565
description: |
5666
examples:
57-
- **Device**: [e.g. iPhone6]
58-
- **OS**: [e.g. iOS8.1]
59-
- **Browser** [e.g. stock browser, safari]
60-
- **Version** [e.g. 22]
67+
- **Device**: [e.g. iPhone6]
68+
- **OS**: [e.g. iOS8.1]
69+
- **Browser** [e.g. stock browser, safari]
70+
- **Version** [e.g. 22]
71+
6172
- type: textarea
6273
id: screenshot
6374
attributes:
@@ -69,7 +80,6 @@ body:
6980
attributes:
7081
label: Relevant log output
7182
description: Add any other context about the problem here.
72-
7383

7484
- type: checkboxes
7585
id: record
@@ -83,8 +93,6 @@ body:
8393
- label: I want to work on this issue
8494
- label: I am a Hacktoberfest contributor
8595

86-
87-
8896
- type: checkboxes
8997
id: terms
9098
attributes:

.github/ISSUE_TEMPLATE/docs.yml

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,24 @@ labels:
99
"good first issue"
1010
]
1111
body:
12+
- type: checkboxes
13+
id: read-guidelines
14+
attributes:
15+
label: Contributor Guidelines
16+
description: Please confirm that you have read the [Contributor Guidelines and Discussion](https://github.com/reactplay/react-play/discussions/1598) before submitting this issue or PR.
17+
options:
18+
- label: I have read the guidelines and discussion
19+
required: true
20+
1221
- type: textarea
1322
id: improve-docs
1423
attributes:
15-
label: what's wrong with the documentation?
16-
description: which things do we need to add?
24+
label: What's wrong with the documentation?
25+
description: Which things do we need to add?
1726
placeholder: Add description
1827
validations:
1928
required: true
29+
2030
- type: textarea
2131
id: screenshots
2232
attributes:
@@ -25,6 +35,7 @@ body:
2535
placeholder: Add screenshots
2636
validations:
2737
required: true
38+
2839
- type: checkboxes
2940
id: terms
3041
attributes:

.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,20 @@ description: Suggest an idea for this project
33
title: '✨ [Feature request]: '
44
labels: ["🚦status: awaiting triage", "💻 aspect: code", "⭐ goal: addition"]
55
body:
6+
- type: checkboxes
7+
id: read-guidelines
8+
attributes:
9+
label: Contributor Guidelines
10+
description: Please confirm that you have read the [Contributor Guidelines and Discussion](https://github.com/reactplay/react-play/discussions/1598) before submitting this issue or PR.
11+
options:
12+
- label: I have read the guidelines and discussion
13+
required: true
14+
615
- type: markdown
716
attributes:
817
value: |
918
Thanks for taking the time for issuing a feature request!
19+
1020
- type: textarea
1121
id: feature-reason
1222
attributes:
@@ -56,7 +66,6 @@ body:
5666
- label: I want to work on this issue
5767
- label: I am a Hacktoberfest contributor
5868

59-
6069
- type: checkboxes
6170
id: terms
6271
attributes:

.github/ISSUE_TEMPLATE/new-play.yml

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
11
name: New Play
22
description: Add a New Play Request
33
title: '[Add a Play]: '
4-
labels: ["play request","🚦status: awaiting triage", "💻 aspect: code" ]
4+
labels: ["play request", "🚦status: awaiting triage", "💻 aspect: code"]
55
body:
6+
- type: checkboxes
7+
id: read-guidelines
8+
attributes:
9+
label: Contributor Guidelines
10+
description: Please confirm that you have read the [Contributor Guidelines and Discussion](https://github.com/reactplay/react-play/discussions/1598) before submitting this issue or PR.
11+
options:
12+
- label: I have read the guidelines and discussion
13+
required: true
14+
615
- type: markdown
716
attributes:
817
value: |

.github/ISSUE_TEMPLATE/refactor.yml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
11
name: Refactor Code 🔧
22
description: Use this label for code refactoring tasks.
33
title: "[Refactor] <write what you want to add>"
4-
labels: ["🛠 goal: refactor", "🚦status: awaiting triage","💻 aspect: code"]
4+
labels: ["🛠 goal: refactor", "🚦status: awaiting triage", "💻 aspect: code"]
55
body:
6+
- type: checkboxes
7+
id: read-guidelines
8+
attributes:
9+
label: Contributor Guidelines
10+
description: Please confirm that you have read the [Contributor Guidelines and Discussion](https://github.com/reactplay/react-play/discussions/1598) before submitting this issue or PR.
11+
options:
12+
- label: I have read the guidelines and discussion
13+
required: true
14+
615
- type: input
716
id: refactor_input
817
attributes:
@@ -11,13 +20,15 @@ body:
1120
placeholder: "For example - src/common"
1221
validations:
1322
required: true
23+
1424
- type: textarea
1525
id: refactor_description
1626
attributes:
1727
label: "Reason for Refactoring the Code"
1828
description: "Describe what improvements can be made in the codebase without introducing breaking changes."
1929
validations:
2030
required: true
31+
2132
- type: checkboxes
2233
id: refactor_terms
2334
attributes:

.github/pull_request_template.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
> **Before creating this PR, please confirm the following:**
2+
> - I have read the [ReactPlay Contributor Guidelines and Discussion](https://github.com/reactplay/react-play/discussions/1598)
3+
> - I have reviewed the [ReactPlay Code Review Checklist](https://github.com/reactplay/react-play/wiki/ReactPlay-Code-Review-Checklist)
4+
> - I have tested my changes locally and verified there are no new warnings or errors
5+
6+
---
7+
18
> First thing, PLEASE READ THIS: [ReactPlay Code Review Checklist](https://github.com/reactplay/react-play/wiki/ReactPlay-Code-Review-Checklist)
29
310
# Description

0 commit comments

Comments
 (0)