Skip to content

Commit b38f0d7

Browse files
committed
Update CONTRIBUTING.md
1 parent 588b950 commit b38f0d7

File tree

1 file changed

+20
-28
lines changed

1 file changed

+20
-28
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,12 @@ https://raytracing.github.io/, so we can keep the content up-to-date with the la
1010
improvements.
1111

1212

13-
Repository Organization
14-
------------------------
15-
This repository has the following organization
16-
17-
```bash
18-
raytracing.github.io/ # Repository root
19-
books/ # Book content
20-
images/ # All figures, renderings and other images used throughout the project
21-
src/ # Source code
22-
common/ # Source code that is common to two or more books
23-
InOneWeekend/ # The final form of source code for Ray Tracing in One Weekend
24-
TheNextWeek/ # The final form of source code for Ray Tracing: The Next Week
25-
TheRestOfYourLife/ # The final form of source code for Ray Tracing: The Rest of Your Life
26-
style/ # CSS for books and web site
27-
```
28-
29-
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 `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).
13+
Development Branches
14+
---------------------
15+
We use `master` as our release branch. _Generally, changes should never go directly to the master
16+
branch_. All ongoing development work (and all of the latest changes) will be in the `dev-patch`,
17+
`dev-minor`, or `dev-major` branches. The appropriate target branch for any pull requests you want
18+
to make will be determined in the associated issue first (all PRs should have an associated issue).
3319

3420

3521
Issues
@@ -49,23 +35,29 @@ please include the file, function/class, and line number(s) if that applies.
4935

5036
Pull Requests
5137
--------------
52-
To contribute a change to the project, please follow these steps:
38+
To contribute a change to the project, *please follow these steps*:
5339

5440
1. [Create a GitHub issue](https://github.com/RayTracing/raytracing.github.io/issues).
5541

56-
2. Participate in the discussion as needed. We'll ensure that the work doesn't conflict with or
42+
2. Let us know whether you're willing to make the fix yourself.
43+
44+
3. Participate in the discussion as needed. We'll ensure that the work doesn't conflict with or
5745
duplicate other work planned or in progress, and decide which development branch is correct
5846
for the release type and release schedule.
5947

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`).
48+
4. Create your changes in a feature branch (or fork) from the assigned development branch
49+
(`dev-patch`, `dev-minor`, `dev-major`).
50+
51+
5. Follow the existing code style.
6252

63-
4. Follow existing code style.
53+
6. Include a one-line summary change at the bottom of the current development section in the
54+
changelog. Include a reference to the associated GitHub issue.
6455

65-
5. When ready, create a pull request and request a review from "rt-contributors".
56+
7. When ready, create your pull request and request a review from "rt-contributors".
6657

67-
New to GitHub? We'll walk you through the process above. Just mention that you'd like a little
68-
guidance in the proposal issue.
58+
If anything above sounds daunting, note that you'll get _massive_ credit for actually reading the
59+
CONTRIBUTING.md and following the process above -- so we'd be delighted to answer any questions and
60+
guide you through the process.
6961

7062

7163
Questions

0 commit comments

Comments
 (0)