Skip to content

Commit 869ffbe

Browse files
authored
Merge pull request #172 from edburns/dd-2790313-pr-templates
On branch dd-2790313-pr-templates Adapted from https://github.com/octokit/octokit-next.js
2 parents 615c065 + 90da1c9 commit 869ffbe

File tree

5 files changed

+193
-0
lines changed

5 files changed

+193
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Bug
2+
description: File a bug report
3+
title: "[BUG]: "
4+
labels: ["Type: Bug", "Status: Triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
- type: textarea
11+
id: what-happened
12+
attributes:
13+
label: What happened?
14+
description: What did you do? What happened? What did you expect to happen?
15+
placeholder: Put your description of the bug here.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: versions
20+
attributes:
21+
label: Versions
22+
description: What versions of the relevant software are you running?
23+
placeholder: copilot-sdk-java v1.0.0, Java 17.0.10, Maven 3.9.6, Copilot CLI v1.0.0
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: logs
28+
attributes:
29+
label: Relevant log output
30+
description: |
31+
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
32+
Please check your logs before submission to ensure sensitive information is redacted.
33+
render: shell
34+
- type: checkboxes
35+
id: terms
36+
attributes:
37+
label: Code of Conduct
38+
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
39+
options:
40+
- label: I agree to follow this project's Code of Conduct
41+
required: true
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Documentation
2+
description: Update or add documentation
3+
title: "[DOCS]: "
4+
labels: ["Type: Documentation", "Status: Triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill this out!
10+
- type: textarea
11+
id: describe-need
12+
attributes:
13+
label: Describe the need
14+
description: What do you wish was different about our docs?
15+
placeholder: Describe the need for documentation updates here.
16+
validations:
17+
required: true
18+
- type: input
19+
id: sdk_version
20+
attributes:
21+
label: SDK Version
22+
description: Do these docs apply to a specific SDK version?
23+
placeholder: copilot-sdk-java v1.0.0
24+
validations:
25+
required: false
26+
- type: textarea
27+
id: logs
28+
attributes:
29+
label: Relevant log output
30+
description: |
31+
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
32+
Please check your logs before submission to ensure sensitive information is redacted.
33+
render: shell
34+
- type: checkboxes
35+
id: terms
36+
attributes:
37+
label: Code of Conduct
38+
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
39+
options:
40+
- label: I agree to follow this project's Code of Conduct
41+
required: true

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Feature
2+
description: Suggest an idea for a new feature or enhancement
3+
title: "[FEAT]: "
4+
labels: ["Type: Feature", "Status: Triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill this out!
10+
- type: textarea
11+
id: describe-need
12+
attributes:
13+
label: Describe the need
14+
description: What do you want to happen? What problem are you trying to solve?
15+
placeholder: Describe the need for the feature.
16+
validations:
17+
required: true
18+
- type: input
19+
id: sdk_version
20+
attributes:
21+
label: SDK Version
22+
description: Does this feature suggestion apply to a specific SDK version?
23+
placeholder: copilot-sdk-java v1.0.0
24+
validations:
25+
required: false
26+
- type: textarea
27+
id: logs
28+
attributes:
29+
label: Relevant log output
30+
description: |
31+
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
32+
Please check your logs before submission to ensure sensitive information is redacted.
33+
render: shell
34+
- type: checkboxes
35+
id: terms
36+
attributes:
37+
label: Code of Conduct
38+
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
39+
options:
40+
- label: I agree to follow this project's Code of Conduct
41+
required: true
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Maintenance
2+
description: Dependencies, cleanup, refactoring, reworking of code
3+
title: "[MAINT]: "
4+
labels: ["Type: Maintenance", "Status: Triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill this out!
10+
- type: textarea
11+
id: describe-need
12+
attributes:
13+
label: Describe the need
14+
description: What do you want to happen?
15+
placeholder: Describe the maintenance need here.
16+
validations:
17+
required: true
18+
- type: input
19+
id: sdk_version
20+
attributes:
21+
label: SDK Version
22+
description: Does this maintenance apply to a specific SDK version?
23+
placeholder: copilot-sdk-java v1.0.0
24+
validations:
25+
required: false
26+
- type: textarea
27+
id: logs
28+
attributes:
29+
label: Relevant log output
30+
description: |
31+
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
32+
Please check your logs before submission to ensure sensitive information is redacted.
33+
render: shell
34+
- type: checkboxes
35+
id: terms
36+
attributes:
37+
label: Code of Conduct
38+
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
39+
options:
40+
- label: I agree to follow this project's Code of Conduct
41+
required: true

.github/pull_request_template.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!-- Please refer to our contributing docs for any questions on submitting a pull request -->
2+
<!-- Issues are required for both bug fixes and features. -->
3+
Resolves #ISSUE_NUMBER
4+
5+
----
6+
7+
### Before the change?
8+
<!-- Please describe the current behavior that you are modifying. -->
9+
10+
*
11+
12+
### After the change?
13+
<!-- Please describe the behavior or changes that are being added by this PR. -->
14+
15+
*
16+
17+
### Pull request checklist
18+
- [ ] Tests for the changes have been added (for bug fixes / features)
19+
- [ ] Docs have been reviewed and added / updated if needed (for bug fixes / features)
20+
- [ ] `mvn spotless:apply` has been run to format the code
21+
- [ ] `mvn clean verify` passes locally
22+
23+
### Does this introduce a breaking change?
24+
<!-- If this introduces a breaking change make sure to note it here and what the impact might be -->
25+
26+
- [ ] Yes
27+
- [ ] No
28+
29+
----

0 commit comments

Comments
 (0)