-
Notifications
You must be signed in to change notification settings - Fork 8
Home
Welcome to the MPI Standard issues repository.
This repository is public to allow anyone to participate in the MPI Forum by viewing and contributing to issues. The associated source code for the MPI Standard however, is kept private to avoid allowing unofficial copies of the MPI Standard to be easily created (see below for how to request access to this private repository).
If you're looking for the homes of the various working groups involved in the MPI Forum, that is maintained on the website.
We have a Slack where people can collaborate on MPI Forum discussions (not meant to replace the mailing lists, but to augment them for those who would like to use it). You can get access to the Slack at this link.
If you're just getting started with Git, GitHub, and/or the MPI Forum's usage of Git+GitHub, you should probably read the following wiki pages in order.
- Git and GitHub definitions and notation
- Overview of the MPI Forum's GitHub usage
- Initial Git setup
- Initial GitHub setup
- Access to the MPI Forum private repository
- Clone the main MPI standards document repo
- Fork the MPI Forum mpi standard repo (on GitHub)
Wesley Bland (@wesbland) and Jeff Squyres (@jsquyres) made "MPI Forum Intro to Git and GitHub":
-
Branch Management: How the MPI Forum manages its Git branches in the
mpi-forum/mpi-standardrepository. -
How to file an MPI Forum issue ("ticket"): High-level workflow for filing a GitHub issue and corresponding GitHub pull request to add/edit/delete text in an MPI document.
- NOTE: This wiki page focuses on GitHub mechanisms. Examples of corresponding Git commands for filing a GitHub pull request are described in other wiki pages, below.
-
Working Group Guidelines: Guidelines and suggestions for how Working Groups should interact with their repo and the main MPI Forum repo.
- NOTE: This wiki pages shows two suggested models for Working Groups. Example git commands for each of the two suggested models are described in other wiki pages, below.
-
There are three typical ways to create a GitHub pull request:
- Creating Simple Pull Request: The Git/GitHub process for proposing new text directly into the MPI standard repo (i.e., without going through a Working Group).
- Working Group Example 1: The Git/GitHub process for proposing text the first model for Working Groups (i.e., the Fault Tolerance Working Group (FTWG) repo), and then up into the main MPI Forum repo.
- Working Group Example 2: The Git/GitHub process for proposing text the second model for Working Groups (i.e., the Tools Working Group repo), and then up into the main MPI Forum repo.
The general timeline and process for ratifying MPI 4.0 is outlined in slides presented by Wesley during the September 2020 Exceptional Virtual Meeting.
Below are some specifics for Chapter Committees and the MPI Standard Document Editor to describe the specific process and steps to construct the final document.
- Chapter Committee Ratification Guidelines: The chapter committees should follow these guidelines to review the document and report any issues.
- MPI Standard Document Editor RC Guidelines: The editor should follow these guidelines to construct the release candidates and final document.