From c1e563ec6d01c369366bb7b9e26e7f7d6fb01d51 Mon Sep 17 00:00:00 2001 From: Alex Mykyta Date: Sat, 24 Jun 2023 11:16:21 -0700 Subject: [PATCH] Add issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 28 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 23 +++++++++++++++++++ .github/ISSUE_TEMPLATE/question.md | 10 ++++++++ 3 files changed, 61 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..9c988c4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,28 @@ +--- +name: Bug report +about: The compiler is not doing what I expected +title: "[BUG]" +labels: '' +assignees: '' + +--- + +**Is this related to a PeakRDL sub-command?** +If so, please open an issue in the appropriate `PeakRDL-***` project: https://github.com/orgs/SystemRDL/repositories + + +**Describe the bug** +A clear and concise description of what the bug is. + +Details like these can be helpful: +* Sample SystemRDL code +* Error message or example output +* Version numbers for the tool, Python, and OS + + +**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/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..521e775 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[FEATURE]" +labels: '' +assignees: '' + +--- + +**Is this related to a PeakRDL sub-command?** +If so, please open an issue in the appropriate `PeakRDL-***` project: https://github.com/orgs/SystemRDL/repositories + +**Describe the problem/limitation you think should be addressed** +A clear and concise description of what the problem is. + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..1f7917d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,10 @@ +--- +name: Question +about: I have a question +title: '' +labels: '' +assignees: '' + +--- + +Please consider using the discussion board for more open-ended questions: https://github.com/orgs/SystemRDL/discussions