OpenPMIx
  • 1. Quick start
  • 2. History
  • 3. Release Notes
  • 4. Exceptions to the PMIx Standard
  • 5. Getting help
  • 6. Installation
  • 7. Version Numbers and Binary Compatibility
  • 8. Developer’s guide
    • 8.1. Prerequisites
    • 8.2. GitHub, Git, and related topics
      • 8.2.1. GitHub
      • 8.2.2. Git commits: open source / contributor’s declaration
      • 8.2.3. Git branch scheme
    • 8.3. Manually installing the GNU Autootools
    • 8.4. Installing and running Sphinx (building the OpenPMIx docs)
    • 8.5. ReStructured Text for those who know Markdown
  • 9. Contributing to OpenPMIx
  • 10. License
  • 11. OpenPMIx Security Policy
  • 12. OpenPMIx manual pages
OpenPMIx
  • 8. Developer’s guide
  • 8.2. GitHub, Git, and related topics
  • View page source

8.2. GitHub, Git, and related topics

8.2.1. GitHub

OpenPMIx’s Git repositories are hosted at GitHub.

  1. First, you will need a Git client. We recommend getting the latest version available. If you do not have the command git in your path, you will likely need to download and install Git.

  2. openpmix is the main OpenPMIx repository where most active development is done. Git clone this repository. Note that the use of the --recursive CLI option is necessary because OpenPMIx uses Git submodules:

    shell$ git clone --recursive https://github.com/openpmix/openpmix.git
    

Note that Git is natively capable of using many forms of web proxies. If your network setup requires the user of a web proxy, consult the Git documentation for more details.

8.2.2. Git commits: open source / contributor’s declaration

In order to remain open source, all new commits to the OpenPMIx repository must include a Signed-off-by: line, indicating the submitter’s agreement to the OpenPMIx Contributor’s Declaration.

Tip

You can use the -s option to git commit to automatically add the Signed-off-by: line to your commit message.

8.2.3. Git branch scheme

Generally, OpenPMIx has two types of branches in its Git repository:

  1. main:

    • All active development occurs on the main branch (new features, bug fixes, etc.).

  2. Release branches of the form vMAJOR.MINOR.x (e.g., v4.0.x, v4.1.x, v5.0.x).

    • The .x suffix indicates that this branch is used to create all releases in the OpenPMIx vMAJOR.MINOR series.

    • Periodically, the OpenPMIx community will make a new release branch, typically from main.

    • A Git tag of the form vMAJOR.MINOR.RELEASE is used to indicate the specific commit on a release branch from where official OpenPMIx release tarball was created (e.g., v4.1.0, v4.1.1, v4.1.2, etc.).

Previous Next

© Copyright 2014-2023, The OpenPMIx Community.

Built with Sphinx using a theme provided by Read the Docs.