Skip to content

Commit

Permalink
chore(github): adds bug report and feature request template
Browse files Browse the repository at this point in the history
  • Loading branch information
arthurgousset committed Mar 23, 2024
1 parent c500d4c commit 8c4b8c9
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG-FORM.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Bug report
description: File a bug report
labels: ["bug report"]
body:
- type: markdown
attributes:
value: |
Please ensure that the bug has not already been filed in the issue tracker.
Thanks for taking the time to report this bug!
- type: input
attributes:
label: What version of the package are you on?
description: |
For local installations, run: `npm list <package-name>`
For global installations, run: `npm list -g <package-name>`
placeholder: "Run command above and paste the output here"
- type: input
attributes:
label: What command or function is the bug in?
description: Leave empty if not relevant
- type: dropdown
attributes:
label: Operating System
description: What operating system are you on?
options:
- Windows
- macOS (Intel)
- macOS (Apple Silicon)
- Linux
- type: textarea
attributes:
label: Describe the bug
description: Please include relevant code snippets, terminal output, and screenshots if relevant.
validations:
required: true
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE-FORM.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Feature request
description: Suggest a feature
labels: ["feature request"]
body:
- type: markdown
attributes:
value: |
Please ensure that the feature has not already been requested in the issue tracker.
Thanks for helping us improve Celo packages!
- type: textarea
attributes:
label: Describe the feature you would like
description: Please also describe what the feature is aiming to solve, if relevant.
validations:
required: true
- type: textarea
attributes:
label: Additional context
description: Add any other context to the feature (like screenshots, code snippets, resources)
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Github Discussions
url: https://github.com/celo-org/compliance/discussions
about: Please ask and answer questions here.
- name: Docs
url: https://docs.celo.org/
about: Documentation on the Celo Platform

0 comments on commit 8c4b8c9

Please sign in to comment.