Skip to content

Commit

Permalink
chore(github): Update Issue templates (#4284)
Browse files Browse the repository at this point in the history
## Summary\*

Bug Report & Feature Request templates
- Add "Project Impact" and "Workaround" sections
- Minor updates

Bug Report template
- Add NoirJS in the "Environment" section

Preview:
- Bug Report:
https://github.com/Savio-Sou/noir/issues/new?template=bug_report.yml
- Feature Request:
https://github.com/Savio-Sou/noir/issues/new?template=feature_request.yml

## Documentation\*

Check one:
- [x] No documentation needed.
- [ ] Documentation included in this PR.
- [ ] **[Exceptional Case]** Documentation to be submitted in a separate
PR.

# PR Checklist\*

- [x] I have tested the changes locally.
- [x] I have formatted the changes with [Prettier](https://prettier.io/)
and/or `cargo fmt` on default settings.
  • Loading branch information
Savio-Sou authored Feb 8, 2024
1 parent ba25a97 commit 1786d8a
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 28 deletions.
63 changes: 42 additions & 21 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
attributes:
value: |
# Description
Thanks for taking the time to create the Issue, and welcome to the Noirot family!
Thanks for taking the time to create the Issue and welcome to the Noir community!
- type: textarea
id: aim
attributes:
Expand Down Expand Up @@ -38,45 +38,69 @@ body:
2.
3.
4.
- type: dropdown
id: impact
attributes:
label: Project Impact
description: How does this affect a project you or others are working on?
options:
- "Nice-to-have"
- "Blocker"
- type: textarea
id: impact_context
attributes:
label: Impact Context
description: If a nice-to-have / blocker, supplement how does this Issue affect the project.
- type: dropdown
id: workaround
attributes:
label: Workaround
description: Is there a workaround for this Issue?
options:
- "Yes"
- type: textarea
id: workaround_description
attributes:
label: Workaround Description
description: If yes, supplement how could the Issue be worked around.
- type: textarea
id: additional
attributes:
label: Additional Context
description: Supplement further information if applicable.
- type: markdown
attributes:
value: |
# Environment
Specify your versions of Noir releases used.
Specify your version of Noir tooling used.
- type: markdown
attributes:
value: |
## Using Nargo?
## Nargo (CLI)
- type: dropdown
id: nargo-install
attributes:
label: Installation Method
description: How did you install Nargo?
multiple: false
options:
- Binary
- Binary (`noirup` default)
- Compiled from source
- type: input
id: nargo-version
attributes:
label: Nargo Version
description: What is the output of the `nargo --version` command?
placeholder: "nargo 0.6.0 (git version hash: 0181813203a9e3e46c6d8c3169ad5d25971d4282, is dirty: false)"
description: Output of running `nargo --version`
placeholder: "nargo version = 0.23.0 noirc version = 0.23.0+5be9f9d7e2f39ca228df10e5a530474af0331704 (git version hash: 5be9f9d7e2f39ca228df10e5a530474af0331704, is dirty: false)"
- type: markdown
attributes:
value: |
## Using TypeScript?
Please await for our new set of packages.
You can find our target release timeframe on the [Noir Roadmap](https://github.com/orgs/noir-lang/projects/1/views/16).
- type: markdown
attributes:
value: |
# Misc
- type: textarea
id: additional
## NoirJS (JavaScript)
- type: input
id: noirjs-version
attributes:
label: Additional Context
description: Supplement further information if applicable.
label: NoirJS Version
description: Version number of `noir_js` in `package.json`
placeholder: "0.23.0"
- type: markdown
attributes:
value: |
Expand All @@ -87,11 +111,8 @@ body:
label: Would you like to submit a PR for this Issue?
description: Fellow contributors are happy to provide support where applicable.
options:
- "No"
- "Maybe"
- "Yes"
validations:
required: true
- type: textarea
id: pr_support
attributes:
Expand Down
31 changes: 24 additions & 7 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
attributes:
value: |
## Description
Thanks for taking the time to create the Issue, and welcome to the Noirot family!
Thanks for taking the time to create the Issue and welcome to the Noir community!
- type: textarea
id: problem
attributes:
Expand All @@ -21,11 +21,31 @@ body:
description: Describe how you think it should work. Supply pseudocode / step-by-step examples if applicable.
validations:
required: true
- type: dropdown
id: impact
attributes:
label: Project Impact
description: How does this affect a project you or others are working on?
options:
- "Nice-to-have"
- "Blocker"
- type: textarea
id: alternatives
id: impact_context
attributes:
label: Alternatives Considered
description: Describe less-happy cases you have considered, if any.
label: Impact Context
description: If a nice-to-have / blocker, supplement how does this Issue affect the project.
- type: dropdown
id: workaround
attributes:
label: Workaround
description: Is there a workaround for this Issue?
options:
- "Yes"
- type: textarea
id: workaround_description
attributes:
label: Workaround Description
description: If yes, supplement how could the Issue be worked around.
- type: textarea
id: additional
attributes:
Expand All @@ -42,11 +62,8 @@ body:
description: Fellow contributors are happy to provide support where applicable.
multiple: false
options:
- "No"
- "Maybe"
- "Yes"
validations:
required: true
- type: textarea
id: pr-support
attributes:
Expand Down

0 comments on commit 1786d8a

Please sign in to comment.