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.

Sign up for GitHub

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

Add info about branches in README.md #301

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a7b50f
Add info about branches in README.md
abellina Jun 29, 2020
1722980
Reword branch description
abellina Jun 29, 2020
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
View file
Open in desktop
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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nit: is a more stable branch , perhaps ? Instead if should be.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@kuhushukla, please take another look. I made it slightly different.


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