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

Added description of the current HDF5 branches; added a draft of contribution policy. #445

Merged
merged 12 commits into from
Mar 19, 2021
2 changes: 2 additions & 0 deletions MANIFEST
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,9 @@

./config/site-specific/BlankForm

./doc/branches-explained.md
./doc/code-conventions.md
./doc/contributing.md

./doxygen/aliases
./doxygen/Doxyfile.in
Expand Down
39 changes: 39 additions & 0 deletions doc/branches-explained.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# HDF5 Git Branching Model Explained

This document desribes current HDF5 branches.
epourmal marked this conversation as resolved.
Show resolved Hide resolved

Branches are tested nightly and testing results are available at https://cdash-internal.hdfgroup.org/ and https://cdash.hdfgroup.org/. Commits that break daily testing should be fixed by 3:00 pm Central time or reverted. We encourgae code contributors to check the status of their commits. If you have any questions, please conrtact lrknox@hdfgroup.org.
epourmal marked this conversation as resolved.
Show resolved Hide resolved

## `develop`
Develop is the main branch whose source code always reflects a state with the latest delivered development changes for the next major release of HDF5.
This is also considered the integration branch, as **all** new features are integrated into this branch from respective feature branches.

## `Maintenance branches`

Each currently supported release-line of HDF5 (e.g. 1.8.x, 1.10.x, 1.12.x) has a support branch with the name 1_8, 1_10, 1_12.
Maintenance branches are similar to the develop branch, except the source code in a maintenance branch always reflects a state
with the latest delivered development changes for the next **maintenance** release of that particular supported release-line of HDF5.
**Some** new features will be integrated into a release maintenance branch, depending on whether or not those features can be
introduced in minor releases. Maintenance branches are removed when a release-line is retired from support.

## `feature/*`
Feature branches are temporary branches used to develop new features in HDF5.
Feature branches branch off of develop and exist as long as the feature is under development.
When the feature, the branch is merged back into develop, as well as any support branches in which the change will be included, and then the feature branch is removed.
epourmal marked this conversation as resolved.
Show resolved Hide resolved

## `release/*`
Release branches are used to prepare a new production release. They are primarily used to allow for last minute dotting of is and crossing of ts
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

last minute dotting of is and crossing of ts
S.B.
last minute dotting of i's and crossing of t's

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

(things like setting the release version, finalizing release notes, et cetera) and do not include new development.
They are created from maintenance branch at the time of the maintenance release and have
epourmal marked this conversation as resolved.
Show resolved Hide resolved
names 1_8_N, 1_10_N, 1_12_N, where N is minor release number. Once the release is done it is tagged.
epourmal marked this conversation as resolved.
Show resolved Hide resolved
Patches can be applied to release branch for patch releases that are treated as "scaled down" maintenance releases as defined by Release coordinator.
epourmal marked this conversation as resolved.
Show resolved Hide resolved

## `1.X/master/*` where X is 8, 10 or 12
These branches are used to tag 1.X.* maintenance releases.

## `inactive/<name>/*`
These branches are for experimantal features that were developed in the past and have not been merged to develop, and are not under active development. The features
can be out of sync with the develop branch.

This document was last updated on March 4, 2021

83 changes: 83 additions & 0 deletions doc/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# How to contribute to HDF5 (Draft)

The HDF Group encourges community members to contribute to the HDF5 project. We accept and are very grateful for any type of contribuitons
epourmal marked this conversation as resolved.
Show resolved Hide resolved
from small typos and bug fixes to new features. The HDF Group is committed to work with the code contributors and make contribution process simple and enjoable.
epourmal marked this conversation as resolved.
Show resolved Hide resolved

This document describes guiding principles for the HDF5 code contributors and does not pretend to address any possible
contribution. If in doubt, please do not hesitate to ask us for guidance.
***Note that no contribution may be accepted unless the donor agrees with the HDF Group software license terms
found in the COPYING file in the top source directory of every branch.***


> We will assume that you are familiar with `git` and `GitHub`. If not, you may go through the GitHub tutorial found at [https://guides.github.com/activities/hello-world/](https://guides.github.com/activities/hello-world/). This tutorial should only take around 10 minutes.

## Table of Contents

* [Workflow](#workflow)
* [Acceptance criteria for pull request](#criteria)
* [Check List](#checklist)

# Workflow <A NAME="workflow"></A>

The process for contributing code to HDF5 is as follows:

* Open an issue on [HDF5 GitHub](https://github.com/HDFGroup/hdf5/issues).

> This step is ***required*** unless the change is minor (e.g., typo fix). If reporting an issue, please follow a template found in issue_template.md file if possible.

* Fork [HDF5](https://github.com/HDFGroup/hdf5) repository.
epourmal marked this conversation as resolved.
Show resolved Hide resolved
* Make the desired changes to the HDF5 software.
* New features should always go to develop branch first and later should be merged to the appropriate maintenance branches.
* Bug fixes should go to all appropriate branches (develop and maintenance).
* Build and test your changes. Detailed instructions on how to build and test HDF5 can be found in the `INSTALL*` files in the `release_docs` directory.
* Push your changes to GitHub.
* Issues a pull request and address any code formatting and testing issues reported.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Issue a pull request

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed.


Once a pull request is correctly formatted and passes GitHub tests, it will be reviewed and evaluated by The HDF Group developers and HDF5 community members who has approval power.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... passes ALL CI tests ...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

members who can approve pull requests

The HDF Group developers will work with you to assure that the pull request satisfies acceptance criteria described in the next section.

# Acceptance criteria for pull request <A NAME="criteria"></A>

We appreciate every contribution we receive, but we do not accept them all. Those that we *do* accept satisfy the following criteria:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... but we may not accept all of them.


* **Pull request has a clear purpose** - What does the pull request address? How does it benefit the HDF5 community?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

THE pull request...

If the pull request does not have a clear purpose and benifits it will not be accepted.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo 'benifits'


* **The pull request is documented** - The HDF5 developers must understand not only *what* a change is doing, but *how* it is doing it. Documenting the code makes it easier for us to understand your patch and will help to maintaine the code in the future.

* **The pull request passes HDF5 regression testing** - Any issue fixed or functionality added should be accompanied by the corresponding tests and pass HDF5 regression testing run by The HDF Group. We do not expect you to perform comprehensive testing across a multiple platforms before we accept the pull request. If the pull request does not pass regression testing after the merge, The HDF Group developers will work with you on the fixes.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

testing across multiple platforms (no "a")

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed.


* **The pull request does not compromise the principles behind HDF5** - HDF5 has a 100% commitment to backward compatibility.
* Any file ever created with HDF5 must be readable by any future version of HDF5.
If the purpose of your patch is to modify HDF5 data model or file format,
**please** discuss this with us first. File format changes and features required those changes can be introduced only in a new major release.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggested: features required {by or for} those changes

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed.

* HDF5 has a commitment to remaining *machine-independent*; data created on one platform/environment/architecture **must** remain readable by HDF5 on another.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'on another' -> 'on any other'?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

* For binary compatibilty no changes are allowed to public APIs and data structures in the maintenance releases; new APIs can be added.
epourmal marked this conversation as resolved.
Show resolved Hide resolved

* **New features are documented** - Any new features should have proper documentation; talk to us if you have any questions.


# Checklist <A NAME="checklist"></A>

Please make sure that you check the items applicable to your pull request:

* Code
* [ ] Does the pull request have a coresponding GitHub issue and clear purpose?
epourmal marked this conversation as resolved.
Show resolved Hide resolved
* [ ] Does the pull request follow HDF5 best practices (naming convensions, code portability, code structure, etc.)? <<TODO: link to the document>>
* [ ] If changes were done to autotools build were they added to CMake and vice versa??
* [ ] Is the pull request applicable to any other branches? If yes, which ones? Please document it in the GitHub issue.
* [ ] Is the new code sufficiently documented for future maintenance?
* Documentation
* [ ] Was the change described in the release_docs/RELEASE.txt file?
* [ ] Was MANIFEST updated if new files had been added to the source?
* [ ] Was new function documented in the corresponding public header file using Doxygen? <<TODO: link tp Doxygen instructions>>
* [ ] Was new functionality documented for the HDF5 community (the level of documentation depends on the feature; ask us what would be appropriate)
* Testing
* [ ] Does the pull request have tests?
* [ ] If a new feature is added, does it affect HDF5 library perfromance?
* [ ] Does new feature introduce backward or forward incompatibility? <<TODO: link to the document>>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe include, provide, or address instead of introduce

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reworked the line and moved it to coding section. We do have info on Macros, but not on format versioning. I need to get things together and post them.


We want as many contributions as we can get, and we are here to help. Feel free to reach out to us if you have any questions

Thank you for your contribution!