diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 6404f1f51..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -labels: bug ---- - - - - - -**Describe the bug** -A clear and concise description of what the bug is. - -**Platform**: e.g., x86_64 Linux - -**Compiler**: e.g., gcc 13.2.0 (installed through nix) - -**mlkem-native version**: e.g., v1.0.0 or main-branch - -**How to reproduce** -Steps to reproduce the behavior: -``` - -``` - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..04615f0fd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,61 @@ +# Copyright (c) The mlkem-native project authors +# SPDX-License-Identifier: Apache-2.0 OR ISC OR MIT + +name: Bug report +description: Create a report to help us improve +labels: [bug] +body: + - type: markdown + attributes: + value: | + **Security reports** + + DO NOT report security issues through GitHub issues - instead use GitHub's [private vulnerability reporting](https://github.com/pq-code-package/mlkem-native/security). + - type: textarea + id: describe + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + validations: + required: true + - type: input + id: platform + attributes: + label: Platform + placeholder: e.g., x86_64 Linux + validations: + required: true + - type: input + id: compiler + attributes: + label: Compiler + placeholder: e.g., gcc 13.2.0 (installed through nix) + validations: + required: true + - type: input + id: version + attributes: + label: mlkem-native version + placeholder: e.g., v1.0.0 or main-branch + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: How to reproduce + description: Steps to reproduce the behavior. + render: shell + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional context + description: Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index e0d799c23..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -labels: enhancement ---- - -**Platform**: -Which platform does this concern? -- [ ] platform independent -- [ ] aarch64 -- [ ] x86_64 -- [ ] rv64 -- [ ] other - -**Issue category**: - -Which part(s) of mlkem-native does this issue concern: - -- [ ] core crypto: ML-KEM -- [ ] core crypto: FIPS202 -- [ ] documentation -- [ ] integration -- [ ] CBMC -- [ ] CI -- [ ] Testing - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..2b9740a47 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,43 @@ +# Copyright (c) The mlkem-native project authors +# SPDX-License-Identifier: Apache-2.0 OR ISC OR MIT + +name: Feature request +description: Suggest an idea for this project +labels: [enhancement] +body: + - type: checkboxes + id: platform + attributes: + label: Platform + description: Which platform does this concern? + options: + - label: platform independent + - label: aarch64 + - label: x86_64 + - label: rv64 + - label: other + - type: checkboxes + id: category + attributes: + label: Issue category + description: Which part(s) of mlkem-native does this issue concern? + options: + - label: "core crypto: ML-KEM" + - label: "core crypto: FIPS202" + - label: documentation + - label: integration + - label: CBMC + - label: CI + - label: Testing + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here.