Skip to content

Latest commit

 

History

History
109 lines (61 loc) · 5.43 KB

README.md

File metadata and controls

109 lines (61 loc) · 5.43 KB
Raw

MIP, MD and MG

We differentiate between MD and MIPs.

An overview of the MIPs and MDs can be found in the OVERVIEW.

In addition MG serves as a glossary for terms defined in the MIPs and MDs.

Movement Desiderata (MD)

See MD-0 to get started. A template is provided at md-template.

MDs serve to capture the objectives behind the introduction of a particular MIP. Any

  • wish,
  • requirement, or
  • need

related to MIPs should be documented as an MD and stored in the MD directory.

Movement Improvement Proposal (MIP)

See MIP-0 to get started. A template is provided at mip-template.

Deciding whether to propose

You SHOULD draft and submit an MIP, if any of the following are true:

  • Governance for the relevant software unit or process requires an MIP.
  • The proposal is complex or fundamentally alters existing software units or processes.

AND, you plan to do the work of fully specifying the proposal and shepherding it through the MIP review process.

You SHOULD NOT draft an MIP, if any of the following are true:

  • You only intend to request a change to software units or processes without overseeing specification and review.
  • The change is trivial. In the event that an MIP is required by governance, such trivial changes usually be handled as either errata or appendices of an existing MIP.

Movement Glossary (MG)

See MG-0 to get started. A template is provided at mg-template.

An alphabetically ordered list of terms is provided in the glossary.

MGs serve to capture the definitions of terms introduced in the MIPs and MDs. The creation of a new MG requires an MIP or MG (since new terms are introduced through the MIP or MG).

Files and numbering

Each MIP, MD or MG is stored in a separate subdirectory with the a name mip-<number>, md-<number> or mg-<number>. The subdirectory contains a README.md that describes the MIP, MD, or MG. All assets related to the MIP, MD or MG are stored in the same subdirectory.

An MIP/MD starts as Drafts. They DO NOT acquire a number at this point.

An MIP/MD is assigned their PR number as soon as they are in the Review process. MDs that do not introduce a new MIP/MD are also accepted. Thus, there will be gaps in the MIP/MD number sequence. These gaps will also emerge when MIPs/MDs are deprecated or rejected.

Note

Update the OVERVIEW file with the MIP/MD number, title and other requirements.

PRs that don't introduce a new MIP/MD are also accepted, for example MIPs/MDs can be updated. PRs that Update a MIP/MD should state so in the PR title, e.g. [Update] MIP-.....

Status Terms

An MIP/MD is proposed through a PR. Each MIP/MDG-introducing PR should have a status in the name in the form [Status] ....

An MIP/MG should at all times have one of the following statuses:

  • Draft - (set by author) An MIP/MD that is open for consideration. (It does not yet hold an MIP/MD number)
  • Review - (set by author) The MIP/MD is under peer review. The MIP/MD should receive an MIP/MD number, according to the rules described in the Files and numbering section. At this point the editor should be involved to ensure the MIP/MD adheres to the guidelines.

Note

In case the editors are not available for an unacceptable long period of time, a reviewer should assume the role of the editor interim.

After acceptance the MIP/MD is merged into main and the branch should be deleted.

Additionally, the following statuses are used for MIPs/MDs that are not actively being worked on:

  • Stagnant - an MIP/MD that has not been updated for 6 months.
  • Withdrawn - an MIP/MD that has not been withdrawn.

Finally, an MIP/MD can also be updated:

  • Update - (set by author) An MIP/MD is being updated. The title should list the MIP/MD number, e.g. [Update] MIP-0 ....

Editor

The motivation for the role of the editor is to ensure the readability and easy access of content, until further means, such as automatic rendering becomes available.

Currently the editors are @apenzk.

The editor is responsible for the final review of the MIPs. The editor is responsible for the following:

  • Ensures a high quality of the MIPs/MDs, e.g. checking language while reviewing.
  • Removes content from the MIPs/MDs that is commented out. (e.g. content within <!- -> brackets)
  • Ensures the MIP/MD numbering is correct.
  • Ensures the MIP/MD is in the correct status.
  • Ensures the authors have added themselves to CODEOWNERS, see Code owners.

The editor is not responsible for the content.

Conflict resolution: In the unlikely case, where an editor requests a change from an author that the author does not agree with and communication does not resolve the situation

  • the editor can mandate that the author implements the changes by getting 2 upvotes from reviewers on their discussion comment mentioning the changes.
  • Otherwise the author can merge without the editor requested change.

Code owners

An author commits to becoming the owner of the MIP/MD they propose. This means that for any future changes to the MIP/MD the author will be notified.

This is being implemented by adding the author as a code owner in the .github/CODEOWNERS file for a given MIP/MD.