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

Add additional details to implementation plan template #2703

Merged
merged 2 commits into from
Jul 24, 2023

Conversation

sarayourfriend
Copy link
Collaborator

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

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • [N/A] I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • [N/A] I tried running the project locally and verified that there are no visible errors.
  • [N/A] I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@sarayourfriend sarayourfriend added 🟨 priority: medium Not blocking but should be addressed soon 📄 aspect: text Concerns the textual material in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🧱 stack: mgmt Related to repo management and automations labels Jul 24, 2023
@sarayourfriend sarayourfriend requested a review from a team as a code owner July 24, 2023 00:50
@github-actions github-actions bot added the 🧱 stack: documentation Related to Sphinx documentation label Jul 24, 2023
@github-actions
Copy link

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.

Copy link
Contributor

@obulat obulat left a 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.

documentation/projects/templates/implementation-plan.md Outdated Show resolved Hide resolved

<!-- Describe the implementation step necessary for completion. -->
<!--
List the ordered steps of the plan in the form of imperative-tone issue titles.
Copy link
Member

Choose a reason for hiding this comment

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

👍

Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

Great addition!

@zackkrida zackkrida merged commit 385fc2a into main Jul 24, 2023
41 checks passed
@zackkrida zackkrida deleted the fix/disambiguate-ip-steps branch July 24, 2023 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 aspect: text Concerns the textual material in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: mgmt Related to repo management and automations
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants