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

Major Descriptive Text Changes Process #21

Closed
jjhursey opened this issue Jan 14, 2021 · 1 comment · Fixed by #30
Closed

Major Descriptive Text Changes Process #21

jjhursey opened this issue Jan 14, 2021 · 1 comment · Fixed by #30
Assignees

Comments

@jjhursey
Copy link
Member

jjhursey commented Jan 14, 2021

Currently, the PMIx Standardization Process does not have a formal process for major text changes. For example, significant rewrites of introductory material or movement of chapters.

I would like to propose the following outline for a process (formal language will be in the PR once we agree on the outline):

  • Major Descriptive Text Changes defined as significant changes to descriptive text in the document such as introductory text in a chapter, definitions of terms, re-organization of chapter contents or chapter placement, non-errata level changes to descriptions of APIs including advice to implementors/users. Smaller changes to the text may be considered Errata as proposed in Issue Errata Process #20 .
  • Text Changes must be filed in as a GitHub PR in the draft state linked to all impacted GitHub Issues until ready for broad review.
  • Once the PR is ready for review, it will move out of the draft state and marked with the "RFC" and "Major Text Change" labels. A Straw Poll Comment is added to the PR and email sent to the mailing list.
  • All concerns must be addressed on the PR. The author may withdraw the PR at any time.
  • Once the discussion has consolidated then the Co-Chairs will add the PR to the agenda for the next quarterly meeting. The label "Eligible" will be added at this time.
  • Author(s) presents the PR for discussion at the ASC quarterly meeting in a formal reading.
  • A formal ASC vote is taken to designate as "Pushed Back" or "First Vote Passed"
    • If "Pushed Back" for minor clarifications, the authors can present an abbreviated reading of just the changes since the last presentation duirng the next quarterly meeting before another first vote is taken. The ASC may request a full reading if the changes since the last vote are deemed too expansive.
  • If passed, the author(s) present it again at the following quarterly meeting (formal reading is not required unless requested).
  • A formal ASC vote is taken to designate as "Pushed Back" or "Accepted"
  • "Accepted" will be merged by the Release Managers.
  • The text changes will be included in the next major release.

Since major text changes are difficult to slowly introduce into the text next to the old language, following a "Provisional acceptance" process won't work. Instead, I propose that we follow a slower process more like the "Elevation to Stable status" since the text change will become stable formal language in the document.

This process follows the informal process we adopted in eary 2020 as documented in the pdf slides (slide 10) from the 2020 - Q1 Meeting - Jan. 23, 2020.

@jjhursey
Copy link
Member Author

1Q 2021 ASC Meeting (Feb. 18, 2021)

  • Concern about conflicting major changes and provisional changes. The RMs and authors will need to resolve these conflicts possibly with Revision Exception votes.
  • Acceptance to move forward to a PR.

jjhursey added a commit to jjhursey/governance that referenced this issue Apr 7, 2021
 * Closes pmix#21

Signed-off-by: Joshua Hursey <jhursey@us.ibm.com>
@jjhursey jjhursey self-assigned this Apr 7, 2021
jjhursey added a commit to jjhursey/governance that referenced this issue Apr 8, 2021
 * Closes pmix#21

Signed-off-by: Joshua Hursey <jhursey@us.ibm.com>
jjhursey added a commit to jjhursey/governance that referenced this issue Apr 15, 2021
 * Closes pmix#21

Signed-off-by: Joshua Hursey <jhursey@us.ibm.com>
jjhursey added a commit to jjhursey/governance that referenced this issue Jul 26, 2021
 * Closes pmix#21

Signed-off-by: Joshua Hursey <jhursey@us.ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant