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

Update PrinciplesReviewWorkflow.md for clarity and fix typos #2435

Merged
merged 3 commits into from
Sep 14, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/PrinciplesReviewWorkflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe make "working group" more explicit as Editorial WG

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

- Write up proposed revisions as a GitHub issue (not a pull request)
Copy link
Contributor

Choose a reason for hiding this comment

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

Say which repo?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added a link.

- Inform the Editorial WG via email that the ticket needs discussion (if it doesn’t happen automatically)
Copy link
Contributor

Choose a reason for hiding this comment

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

If what doesn't happen automatically? The informing, or the discussing?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

At the time this was written, it wasn't clear if there was some automatic message sent to members. Since it is now clear that this does not happen, I removed the phrase.

- Two-week commenting period on GitHub issue tracker
- Two-week commenting period on the GitHub issue tracker
- Make any incremental improvements on the tracker
Copy link
Contributor

Choose a reason for hiding this comment

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

Who makes what improvements? This needs clarification

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

- 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
Copy link
Contributor

Choose a reason for hiding this comment

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

Who makes the PR?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

- 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
Copy link
Contributor

Choose a reason for hiding this comment

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

Who uploads it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually, no one. It's merely linked from elsewhere. I clarified the procedure.


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.
Loading