Skip to content

Commit e2f6076

Browse files
committedAug 12, 2023
Update README, CONTRIBUTING for dev/rel branches
The `master` branch is now renamed to the `release` branch. Hopefully this will alleviate the common issues of people submitting PRs to what is essentiall our release branch.
1 parent 5aceff5 commit e2f6076

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed
 

‎CONTRIBUTING.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,12 @@ improvements.
1212

1313
Development Branches
1414
---------------------
15-
We use `master` as our release branch. _Generally, changes should never go directly to the master
15+
We use `release` as our release branch. _Generally, changes should never go directly to the release
1616
branch_. All ongoing development work (and all of the latest changes) will be in the `dev` branch.
1717
However, we may want changes in other development branches (for example, in a `dev-patch` branch for
1818
a quick patch release). The appropriate target branch for any pull requests you want to make will be
1919
determined in the associated issue first (all PRs should have an associated issue).
2020

21-
_**Key Point: submitting a PR to `master` is almost always the wrong move.**_
22-
2321

2422
Issues
2523
-------
@@ -29,8 +27,7 @@ all kinds, even better ways to present something -- just go to the [issues page]
2927
**Before creating a new issue**, please review existing issues to see if someone has already
3028
submitted the same one. Chances are you're not the first to encounter something, so a little quick
3129
research can save everyone some hassle. It's also a good idea to verify that problems still exist in
32-
the development branch (which will be one of `dev-patch`, `dev-minor` or `dev-major`) when creating
33-
new issues.
30+
the development branch (`dev`) when creating new issues.
3431

3532
When entering a new issue, please include all relevant information. For content issues, include the
3633
book or books this applies to, and specific locations that should be reviewed. Similarly for code:

‎README.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -117,10 +117,14 @@ languages (see [_Implementations in Other Languages_][implementations]), and acr
117117
operating systems. Feel free to add your own implementation to the list!
118118

119119
### Branches
120-
The `master` branch contains the latest released (and live) assets. In general, ongoing development,
121-
with all of the latest changes, can be found in the `dev` branch, which may contain patch, minor and
122-
major changes, depending on the release in progress. We try to keep CHANGELOG.md up to date, so you
123-
can easily browse what's new in each development branch.
120+
In general, ongoing development, with all of the latest changes, can be found in the `dev` branch,
121+
which may contain patch, minor and major changes, depending on the release in progress. We try to
122+
keep CHANGELOG.md up to date, so you can easily browse what's new in each development branch. We may
123+
from time to time use additional development branches, so stay up to date by reviewing the
124+
[CONTRIBUTING][] page.
125+
126+
The `release` branch contains the latest released (and live) assets. This is the branch from which
127+
GitHub pages serves up https://raytracing.github.io/.
124128

125129

126130
Building and Running

0 commit comments

Comments
 (0)
Please sign in to comment.