RM Process

From HDF5 Wiki
RM:Process
Jump to navigation Jump to search


The HDF5 source code, which includes the documentation in question, is hosted on GitHub. A change of the documentation is a change of the HDF5 source code, albeit only in comments. Changes to the HDF5 source code are done through pull requests (PR). Such pull requests are created to address specific issues collected at https://github.com/HDFGroup/hdf5/issues. Documentation issues have a documentation tag.

Since documentation changes are a special kind of source code changes, they follow the same general process as source code changes. Below, we describe the documentation-specific aspects of this process.

It is convenient to present this material as a set of checklists.

Before you make changes

  • [ _ ] You have one or more GitHub issue numbers
  • [ _ ] You have created a fork of https://github.com/HDFGroup/hdf5
  • [ _ ] Your working branch is in sync with the target branch
  • [ _ ] Your branch is configured (via Autotools or CMake)
  • [ _ ] You can build the documentation without errors

Before you create a pull request

  • [ _ ] You've addressed the issue(s) through your changes
  • [ _ ] You can build the documentation without errors
  • [ _ ] You have previewed your changes locally
  • [ _ ] The output is formatted as expected
  • [ _ ] The content conforms to the style guidelines
  • [ _ ] All example tests pass

Create and track a pull request

  • [ _ ] You've linked your pull request to the issue(s) using keywords and issue references
  • [ _ ] You've requested a review
  • [ _ ] You've applied suggested changes
  • [ _ ] You've obtained two or more +2 votes from core reviewers

Merging your changes

After your changes have been merged

  • [ _ ] Add a closing comment using keywords to reference the issue you've addressed
  • [ _ ] Pat your back for having made HDF5 better for everyone