diff --git a/.github/ISSUE_TEMPLATE/BUG-FORM.yml b/.github/ISSUE_TEMPLATE/BUG-FORM.yml new file mode 100644 index 0000000000..05c29428ca --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG-FORM.yml @@ -0,0 +1,56 @@ +name: Bug report +description: File a bug report +labels: ["T-bug", "T-needs-triage"] +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 in SP1! + - type: dropdown + attributes: + label: Component + description: What component is the bug in? + multiple: true + options: + - sp1-sdk + - sp1-zkvm + - cargo prove CLI/sp1up + - Other (please describe) + validations: + required: true + - type: checkboxes + attributes: + label: Have you ensured that all of these are up to date? + options: + - label: SP1 SDK + - label: cargo prove CLI/sp1up + - type: input + attributes: + label: What version of SP1 SDK are you on? + description: Leave empty if not relevant + placeholder: "Add the version from the Cargo.toml file here" + - type: input + attributes: + label: What version of the cargo prove CLI are you on? + description: Leave empty if not relevant + placeholder: "Run cargo prove --version and paste the output here" + - type: dropdown + attributes: + label: Operating System + description: What operating system are you on? + options: + - Windows + - macOS (Intel) + - macOS (Apple Silicon) + - Linux (Arch) + - Linux (Debian) + - Linux (Ubuntu) + - Linux (Other) + - type: textarea + attributes: + label: Describe the bug + description: Please include relevant Rust snippets/CLI commands as well if relevant. + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/FEATURE-FORM.yml b/.github/ISSUE_TEMPLATE/FEATURE-FORM.yml new file mode 100644 index 0000000000..17a83d01da --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE-FORM.yml @@ -0,0 +1,32 @@ +name: Feature request +description: Suggest a feature +labels: ["T-feature", "T-needs-triage"] +body: + - type: markdown + attributes: + value: | + Please ensure that the feature has not already been requested in the issue tracker. + + Thanks for helping us improve SP1! + - type: dropdown + attributes: + label: Component + description: What component is the feature for? + multiple: true + options: + - sp1-sdk + - sp1-zkvm + - cargo prove CLI/sp1up + - Other (please describe) + validations: + required: true + - 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, resources) \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..3654e060fc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Support + url: https://t.me/+5q4kfeXaBE1hZjEx + about: This issue tracker is only for bugs and feature requests. Support is available on Telegram! \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..81d60ecec0 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,36 @@ + + + + +## Motivation + + + +## Solution + + + +## PR Checklist + +- [ ] Added Tests +- [ ] Added Documentation +- [ ] Breaking changes \ No newline at end of file