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

update dev ticket template #642

Merged
merged 7 commits into from
Apr 18, 2024
Merged

update dev ticket template #642

merged 7 commits into from
Apr 18, 2024

Conversation

jmcook1186
Copy link
Contributor

A description of the changes proposed in the Pull Request

Updates developer ticket template according to discussion here: #613

<!--- enumerate specific changes required to the documentation, formatted as checkboxes with associated urls -->

## Testing
<!--- what tests are required for the changes to get merged? Please use checkboxes!-->
Copy link
Member

Choose a reason for hiding this comment

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

I think it's better to leave at least one line of checkboxes so you don't have to figure out how to write it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good point - adding now

Signed-off-by: Joseph Cook <33655003+jmcook1186@users.noreply.github.com>
@jawache
Copy link
Contributor

jawache commented Apr 13, 2024

Thanks @jmcook1186, every project is now being asked to align to the pm protocol here: https://www.notion.so/grnsft/Internal-Project-Protocol-6b8a9e881ed942df9a81a60aeecfd998?pvs=4 head to the section called "issues". So this will need to change somewhat to conform.

Specifically for IF the ticket should look something like so which follows the protocol and merges with your suggestions.

What: one sentence to describe the deliverable.
Why: can use a user story, but let's not insist, if it's a smaller subtask then user stories just become repetitive and add limited value (as a developer the tests should pass so we have a high quality product) so I think there is room for flexibility.
Context: As per your suggestion
Prerequisites: As per your suggestion
SoW: replaces implementation detail, docs and testing, can add comments to encourage people to think of checklist items related to testing/docs. But this is the place with all the work that needs to be done.
Acceptance Criteria: this should replace "What does done look like?" if the ticket involves a manifest file one of the criteria should be a manifest file that should be runnable. If there is any testing to be done (automation or manual) then the acceptance criteria is the place to understand what testing needs to be done. I'd imagine we flesh this out in refinement with multiple heads.

In addition

  • Size should be either a project board field or a label, we might insist on one or the other in the future but right now there is flexibility to choose. In fact maybe not something we insist on until we've done some refinement on a ticket? But regardless, label or board field, you can only fill it in after the ticket is created.

  • We normally keep it simple with just bolded words for headings (see hackathon board for examples) but I think we can also use headings instead of bolded but let's stick to h4, h2s take up a lot of space unnecessarily 😁

Copy link
Contributor

@jawache jawache left a comment

Choose a reason for hiding this comment

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

As per my comment on the PR

rm reviewer field

Signed-off-by: Joseph Cook <33655003+jmcook1186@users.noreply.github.com>

## Acceptance criteria
<!--- What has to be true for this to get merged? What threshold of testing is acceptable? -->
**Acceptance criteria**
Copy link
Contributor

Choose a reason for hiding this comment

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

@jmcook1186 let's add to the template to trigger thinking in that style

Given ...
When ...
Then ...

.github/ISSUE_TEMPLATE/dev-ticket.md Outdated Show resolved Hide resolved
jmcook1186 and others added 2 commits April 18, 2024 09:39
Signed-off-by: jmc <33655003+jmcook1186@users.noreply.github.com>
Signed-off-by: Asim Hussain <asim@codecraft.tv>
@jawache jawache merged commit c4d99af into main Apr 18, 2024
2 checks passed
@jawache jawache deleted the update-dev-ticket-template branch April 18, 2024 10:24
This was referenced May 17, 2024
@github-actions github-actions bot mentioned this pull request Jun 11, 2024
@github-actions github-actions bot mentioned this pull request Jun 13, 2024
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.

4 participants