Skip to content

Commit

Permalink
maint: adds templates for PR and issue dev flows (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
nickfloyd authored Dec 13, 2023
1 parent d0322ef commit 4cde836
Show file tree
Hide file tree
Showing 5 changed files with 186 additions and 0 deletions.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Bug
description: File a bug report
title: "[BUG]: "
labels: ["Type: Bug", "Status: Triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: What did you do? What happened? What did you expect to happen?
placeholder: Put your description of the bug here.
validations:
required: true
- type: textarea
id: versions
attributes:
label: Versions
description: What versions of the relevant software are you running?
placeholder: octokit/dotnet-sdk v0.0.1, .net v8.0
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](Docs/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Documentation
description: Update or add documentation
title: "[DOCS]: "
labels: ["Type: Documentation", "Status: Triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill this out!
- type: textarea
id: describe-need
attributes:
label: Describe the need
description: What do you wish was different about our docs?
placeholder: Describe the need for documentation updates here.
validations:
required: true
- type: input
id: sdk_version
attributes:
label: SDK Version
description: Do these docs apply to a specific SDK version?
placeholder: octokit/dotnet-sdk v0.0.1
validations:
required: false
- type: input
id: api_version
attributes:
label: API Version
description: Do these docs apply to a specific version of the GitHub REST API or GraphQL API?
placeholder: ex. v1.1.1
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](Docs/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Feature
description: Suggest an idea for a new feature or enhancement
title: "[FEAT]: "
labels: ["Type: Feature", "Status: Triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill this out!
- type: textarea
id: describe-need
attributes:
label: Describe the need
description: What do you want to happen? What problem are you trying to solve?
placeholder: Describe the need for the feature.
validations:
required: true
- type: input
id: sdk_version
attributes:
label: SDK Version
description: Does this feature suggestion apply to a specific SDK version?
placeholder: octokit/dotnet-sdk v0.0.1
validations:
required: false
- type: input
id: api_version
attributes:
label: API Version
description: Does this feature suggestion apply to a specific version of the GitHub REST API or GraphQL API?
placeholder: ex. v1.1.1
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](Docs/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/maintenance.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Maintenance
description: Dependencies, cleanup, refactoring, reworking of code
title: "[MAINT]: "
labels: ["Type: Maintenance", "Status: Triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill this out!
- type: textarea
id: describe-need
attributes:
label: Describe the need
description: What do you want to happen?
placeholder: Describe the maintenance need here.
validations:
required: true
- type: input
id: sdk_version
attributes:
label: SDK Version
description: Does this maintenance apply to a specific SDK version?
placeholder: octokit/dotnet-sdk v0.0.1
validations:
required: false
- type: input
id: api_version
attributes:
label: API Version
description: Does this maintenance apply to a specific version of the GitHub REST API or GraphQL API?
placeholder: ex. v1.1.1
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](Docs/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
30 changes: 30 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<!-- Please refer to our contributing docs for any questions on submitting a pull request -->
<!-- Issues are required for both bug fixes and features. -->
Resolves #ISSUE_NUMBER

----

### Before the change?
<!-- Please describe the current behavior that you are modifying. -->

*

### After the change?
<!-- Please describe the behavior or changes that are being added by this PR. -->

*

### Pull request checklist
- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] Docs have been reviewed and added / updated if needed (for bug fixes / features)

### Does this introduce a breaking change?
<!-- If this introduces a breaking change make sure to note it here any what the impact might be -->

Please see our docs on [breaking changes](https:/octokit/.github/blob/master/community/breaking_changes.md) to help!

- [ ] Yes
- [ ] No

----

0 comments on commit 4cde836

Please sign in to comment.