Skip to content

Commit 6df3cc3

Browse files
authored
Update the contributing guidelines
1 parent 7dd9a80 commit 6df3cc3

File tree

1 file changed

+42
-17
lines changed

1 file changed

+42
-17
lines changed

CONTRIBUTING.md

Lines changed: 42 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,48 +16,73 @@ We use `release` as our release branch. _Generally, changes should never go dire
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
19-
determined in the associated issue first (all PRs should have an associated issue).
19+
determined in the associated issue first (all pull requests should have an associated issue).
2020

2121

2222
Issues
2323
-------
2424
The easiest way to help out is to log any issues you find in the books. Unclear passages, errors of
2525
all kinds, even better ways to present something -- just go to the [issues page][].
2626

27-
**Before creating a new issue**, please review existing issues to see if someone has already
28-
submitted the same one. Chances are you're not the first to encounter something, so a little quick
29-
research can save everyone some hassle. It's also a good idea to verify that problems still exist in
30-
the development branch (`dev`) when creating new issues.
27+
1. First ensure that the issue is still outstanding in the current development branch (`dev`). Often
28+
the issue has already been addressed or no longer applies to the latest in-development version.
3129

32-
When entering a new issue, please include all relevant information. For content issues, include the
33-
book or books this applies to, and specific locations that should be reviewed. Similarly for code:
34-
please include the file, function/class, and line number(s) if that applies.
30+
2. **Before creating a new issue**, please review existing issues to see if someone has already
31+
submitted the same one. Chances are you're not the first to encounter something, so a little
32+
quick research can save everyone some hassle. If you have new information, please continue the
33+
thread in the existing issue.
3534

36-
Finally, _please keep issues focused on a single problem or suggestion_. If discussion prompts you
37-
to think of another related issue, create a new issue for that topic.
35+
3. When entering a new issue, please include all relevant information. For content issues, include
36+
the book or books this applies to, and specific locations that should be reviewed. Similarly for
37+
code: please include the file, function/class, and line number(s) if that applies.
38+
39+
4. Finally, _please keep issues focused on a single problem or suggestion_. If discussion prompts
40+
you to think of a related issue, create a separate issue for that topic and add a link back to
41+
the original discussion or issue (just use the "#NNN" syntax for issue/discussion/pull-request
42+
NNN -- GitHub will automatically make this a link).
3843

3944

4045
Pull Requests
4146
--------------
4247
To contribute a change to the project, *please follow these steps*:
4348

44-
1. [Create a GitHub issue](https://github.com/RayTracing/raytracing.github.io/issues).
49+
1. [Create a new GitHub issue](https://github.com/RayTracing/raytracing.github.io/issues).
4550

46-
2. Let us know whether you're willing to make the fix yourself.
51+
2. Let us know if you're willing to make the fix yourself.
4752

4853
3. Participate in the discussion as needed. We'll ensure that the work doesn't conflict with or
4954
duplicate other work planned or in progress, and decide which development branch is correct
5055
for the release type and release schedule.
5156

52-
4. Create your changes in a feature branch (or fork) from the assigned development branch (usually
53-
`dev`).
57+
4. Once you've received instructions to proceed with your change, create a new feature branch (or
58+
fork) from the assigned development branch (usually `dev`).
5459

5560
5. Follow the existing code style.
5661

57-
6. Include a one-line summary change at the bottom of the current development section in the
58-
changelog. Include a reference to the associated GitHub issue.
62+
6. Ensure that the change is complete:
63+
64+
- Update all relevant source code for all three books (`src/*`). Since the code is developed as
65+
the books proceed, you may need to update many historical code listings as well, _and this
66+
may require corresponding updates to the book text_.
67+
68+
- Update all relevant code listings and text in all three books (`books/RayTracing*.html`).
69+
Follow existing style for the Markdeep source (for example, text should be wrapped to 100
70+
characters).
71+
72+
- Provide clear and full commit descriptions: title line (50 characters max), followed by a
73+
blank line, and then a descriptive body with lines not exceeding 72 characters. If a commit
74+
is expected to completely resolve an outstanding issue, add a line "Resolves #NNN" to the
75+
bottom of your commit message, where NNN is the existing GitHub issue number. You may provide
76+
multiple such lines if applicable.
77+
78+
- Include a one-line summary change at the bottom of the current development section in the
79+
changelog (`CHANGELOG.md`). Include a reference to the associated GitHub issue.
80+
81+
- For an example of the above, see
82+
[issue #1262](https://github.com/RayTracing/raytracing.github.io/issues/1262) and
83+
[PR #1263](https://github.com/RayTracing/raytracing.github.io/pull/1263).
5984

60-
7. When ready, create your pull request and request a review from "rt-contributors".
85+
7. When ready, create your pull request (PR) and request a review from "rt-reviewers".
6186

6287
8. Congratulate yourself for having been part of the 1% of contributors who actually read and
6388
followed these guidelines.

0 commit comments

Comments
 (0)