Skip to content

Commit 8050a26

Browse files
committed
Update info around development branches
1 parent 6d179e5 commit 8050a26

File tree

3 files changed

+18
-13
lines changed

3 files changed

+18
-13
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ raytracing.github.io/ # Repository root
2727
```
2828

2929
The latest official release can be found in the `master` branch. All ongoing development work (and
30-
all of the latest changes) will be in the `development` branch.
30+
all of the latest changes) will be in the `dev-patch`, `dev-minor`, and `dev-major` branches. The
31+
appropriate target branch for any pull requests you want to make will be determined in the
32+
associated issue first (all PRs should have an associated issue).
3133

3234

3335
Issues
@@ -49,17 +51,18 @@ Pull Requests
4951
--------------
5052
To contribute a change to the project, please follow these steps:
5153

52-
1. [Create a GitHub issue](https://github.com/RayTracing/raytracing.github.io/issues)
54+
1. [Create a GitHub issue](https://github.com/RayTracing/raytracing.github.io/issues).
5355

5456
2. Participate in the discussion as needed. We'll ensure that the work doesn't conflict with or
55-
duplicate other work planned or in progress, and makes sense for the next release.
57+
duplicate other work planned or in progress, and decide which development branch is correct
58+
for the release type and release schedule.
5659

57-
3. Create your changes in a feature branch (or fork) from the `development` branch (_not_ from
58-
`master`).
60+
3. Create your changes in a feature branch (or fork) from the assigned development branch
61+
(probably `dev-patch`, `dev-minor`, `dev-major`, or `future`).
5962

6063
4. Follow existing code style.
6164

62-
5. When ready, create a pull request and assign it to "rt-contributors".
65+
5. When ready, create a pull request and request a review from "rt-contributors".
6366

6467
New to GitHub? We'll walk you through the process above. Just mention that you'd like a little
6568
guidance in the proposal issue.

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ of changes to areas of the book that have given readers difficulties. Enjoy!
3333
Branches
3434
---------
3535
The `master` branch contains the code at latest release. All ongoing development, with all of the
36-
latest changes, can be found in the `development` branch. If you have issues to file, you may want
37-
to check to see if they're still present in the `development` branch.
36+
latest changes, can be found in the `dev-patch`, `dev-minor`, and `dev-major` branches.
3837

3938

4039
Downloading The Source Code

index.html

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,14 +69,17 @@ <h1 id='source'>Source Code</h1>
6969

7070
<h1 id='issues'>Issues</h1>
7171

72-
<p>You can browse book suggestions and errors in the
73-
<a href="https://github.com/RayTracing/raytracing.github.io/issues">GitHub issues database</a>. If you have a
74-
suggestion or believe you've found an error, please check these issues first (including closed issues) to ensure that
75-
it hasn't already been reported. If it hasn't, please create a new entry, describing the issue, book, specific
72+
<p>You can browse book suggestions and errors in
73+
<a href="https://github.com/RayTracing/raytracing.github.io/issues">GitHub issues</a>. If you have a suggestion or
74+
believe you've found an error, please check these issues first (including closed ones) to ensure that it hasn't
75+
already been reported. If it hasn't, please create a new entry, describing the problem, book or source file, location,
76+
and whatever other information would be helpful in understanding why you think it's a problem. If possible, include
77+
ideas about what you think the fix should look like.
7678

7779

7880
<h1 id='contributing'>Contributing</h1>
79-
<p>Interested in helping out? Please read the guidelines in the <a href="https://github.com/RayTracing/raytracing.github.io/blob/master/CONTRIBUTING.md">CONTRIBUTING.md</a> document
81+
<p>Interested in helping out? Please read the guidelines in the
82+
<a href="https://github.com/RayTracing/raytracing.github.io/blob/master/CONTRIBUTING.md">CONTRIBUTING.md</a> document
8083
first. <em>Pull requests without associated issues, or submitted without coordination, are highly likely to be
8184
rejected.</em>
8285

0 commit comments

Comments
 (0)