Skip to content

Writing and contributing to issues

Casey Wong edited this page Mar 7, 2020 · 11 revisions

Issue authoring guidelines

For each issue that you want to create, you should write a user story that matches describes what the issue is, from who's perspective and why we want to work on the issue. Additionally, a set of acceptance criteria should accompany the user story so it is clear when an issue can be closed. An example of this is if we wanted to add a feature (tomato) to our product (a sandwich) then the issue could be worded as the following:

As a sandwich developer, I want to add tomatoes to my sandwich so that the sandwich becomes more delicious

Acceptance Criteria

the new sandwich now contains tomatoes

Clone this wiki locally