Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore: Add GitHub issue templates #605

Merged
merged 10 commits into from
May 20, 2022
Merged

Conversation

machikoyasuda
Copy link
Member

closes #604

Discussed at today's Developer Team meeting.

What this PR does

Adds 5 (!!) more issue templates for the following scenarios:

  1. bug report: for anyone to report bugs on the app (to be closed with a corresponding pull request)
  2. user story: for product to write user stories for new features
  3. task: task is for an individual engineering task (to be closed with a corresponding pull request)
  4. deliverable: "deliverable" is our new word for any github issue that's not for a code change. it could be an issue to track work like: user testing, user research, writing planning documents for a meeting. these issues don't end up with a pull request.
  5. epic decision record: this is for our big "epic" issues, which track a group of related user stories, tasks and deliverables. epics can also contain relevant background information, checklist of items that need to be done before the feature can be delivered. epics should have a defined "definition of done", so we know when we can close it.

@machikoyasuda
Copy link
Member Author

@thekaveman @angela-tran I drafted these up! Please comment on any things I should remove, add, change (Or send up your own commits making these changes).

@machikoyasuda machikoyasuda changed the title GitHub issue templates Chore: Add GitHub issue templates May 19, 2022
@thekaveman
Copy link
Member

Thanks for getting this started @machikoyasuda! These look great. Overall I think we can merge sooner than later and refine these as we go and learn more.

I did make a few minor cleanups, reorganizations, heading levels, etc. I also created the deliverable label.

* reorder sections
* remove engineering tasks to keep user focus
* placeholder done text
use headers instead of bold
* simplify title / description
* fix heading levels
* cleanup checklist
@thekaveman thekaveman force-pushed the chore/605-issue-templates branch from cc1ce21 to e9bfbd9 Compare May 20, 2022 01:21
@thekaveman thekaveman marked this pull request as ready for review May 20, 2022 15:48
@thekaveman thekaveman requested a review from a team as a code owner May 20, 2022 15:48
Copy link
Member

@angela-tran angela-tran left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These look great!

@machikoyasuda machikoyasuda merged commit a09ded1 into dev May 20, 2022
@thekaveman thekaveman deleted the chore/605-issue-templates branch May 20, 2022 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create issue templates
3 participants