From c3c2d9e2403711652ba873b00688dc8a8b5ed870 Mon Sep 17 00:00:00 2001 From: "Darren A. Natale" Date: Wed, 13 Sep 2023 08:59:31 -0400 Subject: [PATCH 1/2] Update PrinciplesReviewWorkflow.md for clarity and fix typos --- docs/PrinciplesReviewWorkflow.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/PrinciplesReviewWorkflow.md b/docs/PrinciplesReviewWorkflow.md index 4f36465ba..a41d0e775 100644 --- a/docs/PrinciplesReviewWorkflow.md +++ b/docs/PrinciplesReviewWorkflow.md @@ -3,16 +3,16 @@ layout: doc title: Principle Review Process --- -This page describes the process for reviewing, updating, and creating [OBO Foundry Principles](http://obofoundry.github.io/principles/fp-000-summary.html). +This page describes the process for reviewing, updating, and creating [OBO Foundry Principles](http://obofoundry.github.io/principles/fp-000-summary.html) by the OBO Foundry Editorial Working Group. -- Discuss the principle on working group call +- Discuss the principle during a working group call - Write up proposed revisions as a GitHub issue (not a pull request) - Inform the Editorial WG via email that the ticket needs discussion (if it doesn’t happen automatically) -- Two-week commenting period on GitHub issue tracker +- Two-week commenting period on the GitHub issue tracker - Make any incremental improvements on the tracker -- When the Editorial WG agrees on a final version, discuss on an Operations Committee call or via the issue tracke +- When the Editorial WG agrees on a final version, discuss on an Operations Committee call or via the issue tracker - Make a pull request - Two-week commenting period on the pull request -- Upload final changes to OBO Foundry web site for public viewing. +- Upload final changes to OBO Foundry web site for public viewing The need for a new principle can arise when an existing principle tries to cover too much and requires splitting, or as new needs arise within the community. From f3a0cef31f7f21381a06eaec828298eb46a2d700 Mon Sep 17 00:00:00 2001 From: "Darren A. Natale" Date: Thu, 14 Sep 2023 11:30:44 -0400 Subject: [PATCH 2/2] Update PrinciplesReviewWorkflow.md Addresses Nomi's suggestions and fleshes out some steps. --- docs/PrinciplesReviewWorkflow.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/docs/PrinciplesReviewWorkflow.md b/docs/PrinciplesReviewWorkflow.md index a41d0e775..0bc37026f 100644 --- a/docs/PrinciplesReviewWorkflow.md +++ b/docs/PrinciplesReviewWorkflow.md @@ -1,18 +1,21 @@ --- layout: doc title: Principle Review Process ---- +-- +This page describes the process for reviewing, updating, and creating [OBO Foundry Principles](http://obofoundry.github.io/principles/fp-000-summary.html) by the OBO Foundry Editorial Working Group (EWG). -This page describes the process for reviewing, updating, and creating [OBO Foundry Principles](http://obofoundry.github.io/principles/fp-000-summary.html) by the OBO Foundry Editorial Working Group. +For the following, steps 1-5 are internal to the EWG and steps 6-7 are internal to the OBO Operations Committee. -- Discuss the principle during a working group call -- Write up proposed revisions as a GitHub issue (not a pull request) -- Inform the Editorial WG via email that the ticket needs discussion (if it doesn’t happen automatically) -- Two-week commenting period on the GitHub issue tracker -- Make any incremental improvements on the tracker -- When the Editorial WG agrees on a final version, discuss on an Operations Committee call or via the issue tracker -- Make a pull request -- Two-week commenting period on the pull request -- Upload final changes to OBO Foundry web site for public viewing +1. Discuss the principle during an Editorial Working Group (EWG) call. +2. Write up proposed revisions as a [GitHub issue](https://github.com/OBOFoundry/OBOFoundry.github.io/issues/new?assignees=nataled&labels=attn%3A+Editorial+WG&projects=&template=obo-foundry-principles.md&title=Principle+%23%3CENTER+NUMBER+HERE%3E+%22%3CENTER+NAME+HERE%3E%22) (not a pull request). +3. Inform the Editorial WG via [email](mailto:obo-foundry-editorial-working-group@googlegroups.com) that the ticket needs discussion. +4. Allow a two-week commenting period on the GitHub issue tracker, during which members of the EWG can suggest improvements. +5. If necessary, discuss changes made during the commenting period and finalize the text. +6. Once the EWG agrees on a final version, a member presents the text to the OBO Foundry Operations Committee for discussion during a meeting or via the issue tracker. +7. Once the wording is approved by OBO Operations, a member of the EWG makes a pull request reflecting the consensus of previous discussions. Note that the pull request should be marked as 'draft' if it is a new principle. +8. For new principles or major changes to existing principles, announce the proposal on the [obo-discuss mailing list](mailto:obo-discuss@googlegroups.com) and the [obo-community #general Slack channel](https://app.slack.com/client/T01BAB621JR/C01BDKWDS91) and request public feedback. +9. Allow a two-week commenting period on the pull request. +10. If the feedback includes major changes or objections, re-discuss during an OBO Operations call and re-do any relevant steps indicated above. +11. At the end of the commenting period, assuming no major changes are needed, a member of the EWG will merge the pull request (removing 'draft' status if appropriate) and thereby make the changes public. The need for a new principle can arise when an existing principle tries to cover too much and requires splitting, or as new needs arise within the community.