From 48fb47ccfc58e6a783ad22b6ccdda88382528fbe Mon Sep 17 00:00:00 2001 From: "Darren A. Natale" Date: Thu, 14 Sep 2023 10:28:19 -0400 Subject: [PATCH 1/3] Update EditorialWG.md to remove outdated information (#2436) --- docs/EditorialWG.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/docs/EditorialWG.md b/docs/EditorialWG.md index e21fc1736..ed629193e 100644 --- a/docs/EditorialWG.md +++ b/docs/EditorialWG.md @@ -3,28 +3,25 @@ layout: doc title: Editorial Working Group --- -The primary task of the Editorial WG is to facilitate the review of candidate OBO Foundry ontologies. This task includes developing the principles against which ontologies are reviewed, developing the review process itself, conducting the reviews, and setting policies governing the process. +The primary tasks of the Editorial WG are to develop and maintain OBO Foundry principles and to facilitate the review of candidate OBO Foundry ontologies. This task includes developing the principles against which ontologies are reviewed, developing the review process itself, conducting the reviews, and setting policies governing the process. ## Scope -The OBO Foundry Editorial WG will: +The OBO Foundry Editorial WG is responsible for: -- create guidelines for ontology review process (how we do reviews, operationally) -- create policies for ontology review criteria (what aspects of an ontology and which ontologies we should review) -- manage the ontology review process +- Principles: drafting text, and creating the workflow and guidelines for the principles development process +- Ontologies: reviewing, and creating the workflow and guidelines for the ontology review process +- Policies: crafting the policies for the above -Current activities are focused on creating guidelines for reviews. Once those guidelines are in place, the working group will shift its focus to carrying out the review process, with an aim of reducing the backlog of ontologies awaiting review. +## Guidelines and policies -## Draft guidelines and policies +#### Ontology Review -### Ontology Review +- [Ontology review workflow](/docs/OntologiesReviewWorkflow.html) -- [Ontology review process guidelines](/docs/ReviewProcessGuidelines.html) -- [Ontology review criteria policies](/docs/ReviewCriteriaPolicies.html) +#### Principles Review -### Principles Review - -[Principles review workflow](/docs/PrinciplesReviewWorkflow.html) +- [Principles review workflow](/docs/PrinciplesReviewWorkflow.html) ## Contact Us From fc672675af7e00169db9e0484d7d19f5b268c758 Mon Sep 17 00:00:00 2001 From: "Darren A. Natale" Date: Thu, 14 Sep 2023 11:34:45 -0400 Subject: [PATCH 2/3] Update PrinciplesReviewWorkflow.md for clarity and fix typos (#2435) * Update PrinciplesReviewWorkflow.md for clarity and fix typos * 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 4f36465ba..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). +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 on 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 -- 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 -- 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. From eee6a3c809f680e40b45c95e217c9ed8ef37e98c Mon Sep 17 00:00:00 2001 From: "Darren A. Natale" Date: Thu, 14 Sep 2023 14:17:13 -0400 Subject: [PATCH 3/3] Update PrinciplesReviewWorkflow.md to fix format issue (#2438) --- docs/PrinciplesReviewWorkflow.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/PrinciplesReviewWorkflow.md b/docs/PrinciplesReviewWorkflow.md index 0bc37026f..578481828 100644 --- a/docs/PrinciplesReviewWorkflow.md +++ b/docs/PrinciplesReviewWorkflow.md @@ -1,7 +1,8 @@ --- 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). For the following, steps 1-5 are internal to the EWG and steps 6-7 are internal to the OBO Operations Committee.