Skip to content

Commit

Permalink
chore(github): Update Issue & PR templates (#29)
Browse files Browse the repository at this point in the history
* chore(github): Update Issue templates

* Simplify PR template
  • Loading branch information
Savio-Sou authored Jul 29, 2024
1 parent 8018240 commit ec847b8
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 32 deletions.
65 changes: 52 additions & 13 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ body:
- type: markdown
attributes:
value: |
Thanks for taking the time to create the Issue and welcome to the Noir community!
# Description
Thanks for taking the time to create the Issue, and welcome to the Noirot family!
- type: textarea
id: aim
attributes:
label: Aim
description: Describe what you tried to achieve.
description: Describe high-level what you tried to achieve.
validations:
required: true
- type: textarea
Expand All @@ -38,20 +38,62 @@ body:
2.
3.
4.
- type: markdown
- type: dropdown
id: workaround
attributes:
value: |
# Misc
label: Workaround
description: Is there a workaround for this Issue?
options:
- "Yes"
- type: textarea
id: environment
id: workaround_description
attributes:
label: Environment
description: Specify the versions and environment details for which the issue is occurring.
- type: textarea
label: Workaround Description
description: If yes, supplement how could the Issue be worked around.
- type: input
id: additional
attributes:
label: Additional Context
description: Supplement further information if applicable.
- type: markdown
attributes:
value: |
# Impact
- 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: input
id: blocker_context
attributes:
label: Blocker Context
description: If a blocker, supplement how does this Issue affect the project.
- type: markdown
attributes:
value: |
# Environment
- type: input
id: nargo-version
attributes:
label: Nargo Version
description: Output of running `nargo --version`
placeholder: "nargo version = 0.32.0 noirc version = 0.32.0+c679f01a19b02ad2ac2287c8e699b46887f7872c (git version hash: c679f01a19b02ad2ac2287c8e699b46887f7872c, is dirty: false)"
- type: input
id: noirjs-version
attributes:
label: NoirJS Version
description: Version number of `noir_js` in `package.json`
placeholder: "0.32.0"
- type: input
id: backend-version
attributes:
label: Proving Backend Tooling & Version
description: Type of tooling and version of the Proving Backend used
placeholder: "Barretenberg - bb CLI - 0.46.1"
- type: markdown
attributes:
value: |
Expand All @@ -62,12 +104,9 @@ 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
- type: input
id: pr_support
attributes:
label: Support Needs
Expand Down
43 changes: 32 additions & 11 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ body:
- type: markdown
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!
# Description
- type: textarea
id: problem
attributes:
Expand All @@ -21,33 +21,54 @@ body:
description: Describe how you think it should work. Supply pseudocode / step-by-step examples if applicable.
validations:
required: true
- type: textarea
id: alternatives
- type: dropdown
id: workaround
attributes:
label: Alternatives Considered
description: Describe less-happy cases you have considered, if any.
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: input
id: additional
attributes:
label: Additional Context
description: Supplement further information if applicable.
- type: markdown
attributes:
value: |
## Pull Request
# Impact
- 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: input
id: blocker_context
attributes:
label: Blocker Context
description: If a blocker, supplement how does this Issue affect the project.
- type: markdown
attributes:
value: |
# Pull Request
- type: dropdown
id: pr-preference
attributes:
label: Would you like to submit a PR for this Issue?
description: Fellow contributors are happy to provide support where applicable.
multiple: false
options:
- "No"
- "Maybe"
- "Yes"
validations:
required: true
- type: textarea
- type: input
id: pr-support
attributes:
label: Support Needs
Expand Down
10 changes: 2 additions & 8 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,16 @@
<!-- Thanks for taking the time to improve Noir! -->
<!-- Please fill out all fields marked with an asterisk (*). -->

# Description

## Problem\*

<!-- Describe the problem this Pull Request (PR) resolves / link to the GitHub Issue that describes the problem. -->

Resolves <!-- Link to GitHub Issue -->

## Summary\*

<!-- Describe the changes in this PR. -->
<!-- Supplement code examples and highlight breaking changes, if applicable. -->


## Additional Context

<!-- Supplement further information if applicable. -->


# PR Checklist\*

Expand Down

0 comments on commit ec847b8

Please sign in to comment.