Create release_card_template #1170
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Creation of a new template so we can create release card for component and improve sync of deliveries as highlighted in our new workflow
daine
reviewed
Sep 25, 2024
|
|
||
| --- | ||
|
|
||
| **Summary:** Release of the XXXX component. |
There was a problem hiding this comment.
Same comment about hoping to continue using a user story format. That format improves clarity of the work as well as gives visibility into the value it brings to the user
daine
requested changes
Sep 25, 2024
| **Summary:** Release of the XXXX component. | ||
| When build dev/design and content are all synced and requirements and decisions are documented, we're ready to release component on all touch points. | ||
|
|
||
| *Ddefinition of done:** |
There was a problem hiding this comment.
Suggested change
| *Ddefinition of done:** | |
| ## ✅ Definition of Done / Outcomes |
Comment on lines
+14
to
+19
| - [ ]Merge figma work to main and publish library | ||
| - [ ]Component package is released | ||
| - [ ]Publish new component on documentation website | ||
| - [ ]Related updates to other component pages are made, as needed | ||
| - [ ]Inform engagement team of upcoming release | ||
| - [ ]Publish a release info on slack |
There was a problem hiding this comment.
- Done when design has merged the component in figma
- Done when development has merged the PR r
- Done when development has released the package(s)
- Done when the website has been updated with documentation for the guidance
- Done when a release message has been posted on slack
- Done when engagement team is informed of the release
Comment on lines
+27
to
+33
| **Deliverables:** | ||
| - [ ]Component code added to Github repository | ||
| - [ ]Changelog | ||
| - [ ]EN component page, poster, and assets available on Figma | ||
| - [ ]FR component page, poster, and assets available on Figma | ||
| - [ ]EN guidance is published to the website | ||
| - [ ]FR guidance is published to the website |
There was a problem hiding this comment.
Suggested change
| **Deliverables:** | |
| - [ ]Component code added to Github repository | |
| - [ ]Changelog | |
| - [ ]EN component page, poster, and assets available on Figma | |
| - [ ]FR component page, poster, and assets available on Figma | |
| - [ ]EN guidance is published to the website | |
| - [ ]FR guidance is published to the website |
I believe we can remove this portion too. For example, CHANGELOG is just a part of our process especially since we automated its creation through release please (and we review it prior to release)
Comment on lines
+21
to
+25
| **Acceptance criteria:** | ||
| - [ ]potential breaking changes were identified | ||
| - [ ]If breaking changes > creation of dedicated card to create specific content | ||
| - [ ]Component has been added or updated on the holidays example app | ||
| - [ ]Component has zero accesibility violation on storybook |
There was a problem hiding this comment.
Suggested change
| **Acceptance criteria:** | |
| - [ ]potential breaking changes were identified | |
| - [ ]If breaking changes > creation of dedicated card to create specific content | |
| - [ ]Component has been added or updated on the holidays example app | |
| - [ ]Component has zero accesibility violation on storybook | |
| ## 📜 Acceptance criteria | |
| - [ ] Design ticket is finalized and ready for merge | |
| - [ ] Develop ticket is finalized and ready for merge | |
| - [ ] Documentation ticket is finalized and ready for publishing | |
| - [ ] Content ticket is finalized and ready for publishing |
|
|
||
| --- | ||
|
|
||
| **Summary:** Release of the XXXX component. |
There was a problem hiding this comment.
Also, we can add something here that says "Use the title format Publish: for this type of ticket"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Creation of a new template so we can create release card for component and improve sync of deliveries as highlighted in our new workflow
Summary | Résumé
Test instructions | Instructions pour tester la modification