-
Notifications
You must be signed in to change notification settings - Fork 0
Description
An issue should be detailed and clear enough that anyone on the team can read it and start working on the task.
Ideally, they should never have to ask for clarifications from you.
But be adaptible, if you are writing an issue that you will work on, then it is unnecessary to add too many details. If this is an issue for a new member, please be as detailed and helpful as possible. Let's not be corporate about this lol
🎯 Objective
[Overarching goal that we must achieve. Make sure that each task can be completed within a 2-week window, if not then break it down into smaller tasks (or if this doesn't make sense, then mark it as a larger task).]
📖 Description
[Detailed description about the task. ]
✅ Acceptance Criteria
- [Criteria 1]
- [e.g. package X compiles with colcon build]
- [e.g. Able to rostopic echo X and see data]
🛠️ Implementation
Approach: [Technical solution. Include detailed step-by-step of how you should approach this task with links to proper resources (especially if this is a task for new members).]
Dependencies: [Dependencies]
🔗 Links
Related: [#issue], [#issue]
Blocks: [#issue]
Blocked by: [#issue]