Skip to content

Commit

Permalink
github: Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
fan-ziqi authored Oct 23, 2024
1 parent 26166fb commit 1a92a2a
Show file tree
Hide file tree
Showing 3 changed files with 104 additions and 0 deletions.
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -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.

<!-- Please post terminal logs, minimal example to reproduce, or command to run under three backticks (```) to allow code formatting.
```
Paste your error here
```
For more information on this, check: https://www.markdownguide.org/extended-syntax/#fenced-code-blocks
-->

### System Info

Describe the characteristic of your environment:

<!-- Please complete the following description. -->
- 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
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/proposal.md
Original file line number Diff line number Diff line change
@@ -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
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
name: Question
about: Describe this issue template's purpose here.
title: "[Question] Question title"
labels: question
assignees: ''

---

### Question

<!-- Describe your question here. If you encounter bugs or new feature suggestions, please do not use this template! -->

0 comments on commit 1a92a2a

Please sign in to comment.