Skip to content

Commit

Permalink
chore: add issue and PR templates (#47)
Browse files Browse the repository at this point in the history
  • Loading branch information
pottekkat committed Sep 18, 2023
1 parent caae477 commit fba3aea
Show file tree
Hide file tree
Showing 4 changed files with 133 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
### Description

<!-- Please include a summary of the change and which issue is fixed. -->
<!-- Please also include relevant motivation and context. -->

Fixes # (issue)

### Checklist

- [ ] I have explained the need for this PR and the problem it solves
- [ ] I have explained the changes or the new features added to this PR
- [ ] I have added tests corresponding to this change
- [ ] I have updated the documentation to reflect this change
- [ ] I have verified that this change is backward compatible

<!--
Note:
1. Mark the PR as draft until it's ready to be reviewed.
2. Always add/update tests for any changes unless you have a good reason.
3. Always update the documentation to reflect the changes made in the PR.
4. Make a new commit to resolve conversations instead of `push -f`.
5. To resolve merge conflicts, merge master instead of rebasing.
6. Use "request review" to notify the reviewer after making changes.
7. Only a reviewer can mark a conversation as resolved.
-->
54 changes: 54 additions & 0 deletions .github/workflows/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Bug Report
description: File a bug report
title: "Bug: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report this bug!
_The more information you share, the faster we can identify and fix the bug._
Please check the [open issues](https://github.com/api7/adc/issues) to avoid duplication.
- type: textarea
id: current-behavior
attributes:
label: Current Behavior
description: Describe the issue with the current behavior.
placeholder: |
When I run `adc sync` I get an error message...
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Exxpected Behavior
description: Describe what you expected to happen instead.
placeholder: |
Instead of the error, I expect `adc sync` to...
validations:
required: false
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: Share how we can reproduce this issue. Reports without proper steps are likely to be closed.
placeholder: |
1. Run `adc configure`
2. Run `adc sync` with this configuration file
3. Check APISIX if the configuration is applied
4. ...
validations:
required: true
- type: textarea
id: environment
attributes:
label: Environment
description: Share your environment details. Reports without proper environment details are likely to be closed.
value: |
- APISIX version:
- ADC version (run `adc version`):
- Operating system (run `uname -a`):
validations:
required: true
22 changes: 22 additions & 0 deletions .github/workflows/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Feature Request
description: Suggest a new feature
title: "Feature: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to suggest a new feature.
_The more information you share, the faster we can help you._
Please check the [open issues](https://github.com/api7/adc/issues) to avoid duplication.
- type: textarea
id: description
attributes:
label: Description
description: Describe the feature you would like to see.
placeholder: |
As a user, I want to..., so that...
validations:
required: true
29 changes: 29 additions & 0 deletions .github/workflows/ISSUE_TEMPLATE/improve_docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Improve Documentation
description: Suggest an improvement to the documentation
title: "Docs: "
labels: ["documentation"]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to suggest an improvement to the documentation.
Please check the [open issues](https://github.com/api7/adc/issues) to avoid duplication.
- type: textarea
id: current-state
attributes:
label: Current State
description: Describe the current state of the documentation.
placeholder: |
The documentation for the command... is missing...
validations:
required: true
- type: textarea
id: desired-state
attributes:
label: Desired State
description: Describe the desired state of the documentation.
placeholder: |
The documentation should mention how to use the command... for...
validations:
required: true

0 comments on commit fba3aea

Please sign in to comment.