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

Add info about branches in README.md #301

Merged
merged 2 commits into from
Jun 29, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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, making it 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