Skip to content

Commit

Permalink
chore: add github issue forms (#105)
Browse files Browse the repository at this point in the history
  • Loading branch information
SilverRainZ authored Oct 28, 2021
1 parent 9ad039f commit 73287f6
Show file tree
Hide file tree
Showing 4 changed files with 126 additions and 0 deletions.
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: Bug Report
description: File a bug report
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: input
attributes:
label: Operating System
description: What operating system are you using?
placeholder: "Example: Debian GNU/Linux 9 (stretch)"
validations:
required: true
- type: input
attributes:
label: Go Version
description: What version of golang are you using?
placeholder: "Example: go1.16.5 linux/amd64"
validations:
required: true
- type: input
attributes:
label: Package Version
description: What version of bytedance/gopkg are you using?
placeholder: "Example: 20210913/main/develop"
validations:
required: true

- type: textarea
attributes:
label: Affected Packages
description: Which packages are affected by this issue?
placeholder: |
One package per line, for example:
- lang/fastrand
- collection/skipset
- ...
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: What did you expect to happen?
validations:
required: true
- type: textarea
attributes:
label: Actual Behavior
description: What actually happened?
validations:
required: true
- type: textarea
attributes:
label: Reproduction Steps
description: How do you trigger this bug? Please walk us through it step by step.
placeholder: |
1.
2.
3.
...
validations:
required: true

- type: textarea
attributes:
label: Other Information
description: Do you still need to add any information?
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
blank_issues_enabled: true
contact_links:
- name: Security Bug Report
url: https://github.com/bytedance/gopkg/blob/develop/CONTRIBUTING.md#3-security-bugs
about: |
Please do not report the safe disclosure of bugs to public issues.
Contact us by email ([email protected])
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_reqeust.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Reference: https://github.com/jekyll/jekyll/blob/master/.github/ISSUE_TEMPLATE/feature_request.md

name: Feature Request
description: File a feature request
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
- type: textarea
attributes:
label: Summary
description: Please give a one-paragraph explanation of the feature.
validations:
required: true

- type: textarea
attributes:
label: Motivation
description: Why do you want to see this feature?
validations:
required: true

- type: textarea
attributes:
label: Explanation
description: |
Please explain the proposal as if it was already included in the project and you
were teaching it to another programmer. That generally means:
- Introducing new named concepts.
- Explaining the feature largely in terms of examples.
- If applicable, provide sample error messages, deprecation warnings, or
migration guidance.
*If this is a small feature, you may omit this section.*
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Question
description: Ask a question
labels: ["question"]
body:
- type: textarea
attributes:
label: Question
description: What do you want to know?
validations:
required: true

0 comments on commit 73287f6

Please sign in to comment.