-
Notifications
You must be signed in to change notification settings - Fork 197
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
Add additional details to implementation plan template #2703
Conversation
Full-stack documentation: https://docs.openverse.org/_preview/2703 Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again. You can check the GitHub pages deployment action list to see the current status of the deployments. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for adding this! I was trying to do both the detailed description and the plan in the same section (in different plans), and it was confusing.
Co-authored-by: Olga Bulat <[email protected]>
|
||
<!-- Describe the implementation step necessary for completion. --> | ||
<!-- | ||
List the ordered steps of the plan in the form of imperative-tone issue titles. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great addition!
Description
When reviewing #2676 I realised that our implementation plan template is missing what I view as a key section: the step-by-step plan. An ordered list of the steps is so useful for getting a high-level understanding of how the different requirements of the plan fit together and how the implementation will be paced.
I added a new section for this and renamed "outlined steps" to "step details" to further help disambiguation between the new section and the existing one.
I also added a new section for feature flags, because that was also not explicitly required in the implementation plan despite being a critical consideration.
Testing Instructions
Read the updated template and the description comments I've added or expanded upon and confirm they clearly describe the intention of each section.
Checklist
Update index.md
).main
) or a parent feature branch.Developer Certificate of Origin
Developer Certificate of Origin