From 1a92a2a10cdf33d59f6eacd35b6d8d2aaaf3c4eb Mon Sep 17 00:00:00 2001 From: robotsfan Date: Wed, 23 Oct 2024 19:30:57 +0800 Subject: [PATCH] github: Update issue templates --- .github/ISSUE_TEMPLATE/bug-report.md | 53 ++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/proposal.md | 39 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/question.md | 12 +++++++ 3 files changed, 104 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/proposal.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..a1b4a81 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,53 @@ +--- +name: Bug Report +about: Submit a bug report +title: "[Bug Report] Bug title" +labels: bug +assignees: '' + +--- + +If you are submitting a bug report, please fill in the following details and use the tag [bug]. + +### Describe the bug + +A clear and concise description of what the bug is. + +### Steps to reproduce + +Please try to provide a minimal example to reproduce the bug. Error messages and stack traces are also helpful. + + + +### System Info + +Describe the characteristic of your environment: + + +- Commit: [e.g. 8f3b9ca] +- OS: [e.g. Ubuntu 20.04, Ubuntu 22.04, WSL2] +- ROS Version: [e.g. noetic, melodic] +- Python Version: [e.g. Python 3.8, Conda-Python 3.11] + +### Additional context + +Add any other context about the problem here. + +### Checklist + +- [ ] I have checked that there is no similar issue in the repo (**required**) + +### Acceptance Criteria + +Add the criteria for which this task is considered **done**. If not known at issue creation time, you can add this once the issue is assigned. + +- [ ] Criteria 1 +- [ ] Criteria 2 diff --git a/.github/ISSUE_TEMPLATE/proposal.md b/.github/ISSUE_TEMPLATE/proposal.md new file mode 100644 index 0000000..797c47b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/proposal.md @@ -0,0 +1,39 @@ +--- +name: Proposal +about: Propose changes that are not bug fixes +title: "[Proposal] Proposal title" +labels: enhancement +assignees: '' + +--- + +### Proposal + +A clear and concise description of the proposal. In a few sentences, describe the feature and its core capabilities. + +### Motivation + +Please outline the motivation for the proposal. Summarize the core use cases and user problems and needs you are trying to solve. + +Is your feature request related to a problem? e.g.,"I'm always frustrated when [...]". + +If this is related to another GitHub issue, please link here too. + +### Alternatives + +A clear and concise description of any alternative solutions or features you've considered, if any. + +### Additional context + +Add any other context or screenshots about the feature request here. + +### Checklist + +- [ ] I have checked that there is no similar issue in the repo (**required**) + +### Acceptance Criteria + +Add the criteria for which this task is considered **done**. If not known at issue creation time, you can add this once the issue is assigned. + +- [ ] Criteria 1 +- [ ] Criteria 2 diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..3adb315 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,12 @@ +--- +name: Question +about: Describe this issue template's purpose here. +title: "[Question] Question title" +labels: question +assignees: '' + +--- + +### Question + +