Skip to content

Commit

Permalink
Add info about branches in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
abellina committed Jun 29, 2020
1 parent d6c48d1 commit 7a7b50f
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,15 @@ may file one [here](https://github.com/NVIDIA/spark-rapids/issues/new/choose).

## Build

There are two types of branches in this repository:

* `branch-[version]`: are development branches which can change often. Note that we merge into
the branch with the greatest version number, as that is our default branch.

* `main`: is the branch with the latest released code, and the version tag (i.e. `v0.1.0`)
is held here. `main` will change with new releases, but otherwise it should not change with
every pull request merged, and should be a more stable branch.

We use maven for most aspects of the build. Some important parts of the build execute in
the "verify" phase of maven. We recommend when building at least running to the "verify" phase.

Expand Down

0 comments on commit 7a7b50f

Please sign in to comment.