Skip to content

Commit 5aceff5

Browse files
committed
Update README + CONTRIBUTING post v4-alpha
1 parent 9d4e978 commit 5aceff5

File tree

2 files changed

+45
-25
lines changed

2 files changed

+45
-25
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,12 @@ improvements.
1313
Development Branches
1414
---------------------
1515
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).
16+
branch_. All ongoing development work (and all of the latest changes) will be in the `dev` branch.
17+
However, we may want changes in other development branches (for example, in a `dev-patch` branch for
18+
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).
20+
21+
_**Key Point: submitting a PR to `master` is almost always the wrong move.**_
1922

2023

2124
Issues
@@ -33,6 +36,9 @@ When entering a new issue, please include all relevant information. For content
3336
book or books this applies to, and specific locations that should be reviewed. Similarly for code:
3437
please include the file, function/class, and line number(s) if that applies.
3538

39+
Finally, _please keep issues focused on a single problem or suggestion_. If discussion prompts you
40+
to think of another related issue, create a new issue for that topic.
41+
3642

3743
Pull Requests
3844
--------------
@@ -46,8 +52,8 @@ To contribute a change to the project, *please follow these steps*:
4652
duplicate other work planned or in progress, and decide which development branch is correct
4753
for the release type and release schedule.
4854

49-
4. Create your changes in a feature branch (or fork) from the assigned development branch
50-
(`dev-patch`, `dev-minor`, `dev-major`).
55+
4. Create your changes in a feature branch (or fork) from the assigned development branch (usually
56+
`dev`).
5157

5258
5. Follow the existing code style.
5359

@@ -56,15 +62,18 @@ To contribute a change to the project, *please follow these steps*:
5662

5763
7. When ready, create your pull request and request a review from "rt-contributors".
5864

65+
8. Congratulate yourself for having been part of the 1% of contributors who actually read and
66+
followed these guidelines.
67+
5968
Note the code philosophy outlined in the first section of the first book. In short, the code is
6069
intended to be clear for everyone, using simple C/C++ idioms as much as possible. We have chosen to
6170
adopt _some_ modern conventions where we feel it makes the code more accessible to non-C++
6271
programmers. Please follow the existing coding style and simplicity when offering your suggested
6372
changes.
6473

65-
If anything above sounds daunting, note that you'll get _massive_ credit for actually reading the
66-
CONTRIBUTING.md and following the process above -- so we'd be delighted to answer any questions and
67-
guide you through the process.
74+
If anything above sounds daunting, note that you'll get _**massive**_ credit for actually reading
75+
the CONTRIBUTING.md and following the process above -- so we'd be delighted to answer any questions
76+
and guide you through the process.
6877

6978

7079
Questions

README.md

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -33,18 +33,30 @@ versions, use the print function in your browser.
3333

3434
Project Status
3535
---------------
36-
Version v4.0.0-alpha.1 is now released for SIGGRAPH 2023. Book 1 is largely completed, and we are
37-
driving books 2 and 3 to completion, with a final release date by the end of 2023. It's been a long
38-
journey from v3.2.3, released December 2020, but we're seeing the finish line.
36+
Phew! We had a great SIGGRAPH in LA, including a birds-of-a-feather session for those interested in
37+
the book series. We had about 50 people attending. I won't recap everything presented there, but
38+
there are three main items that everyone should know about.
3939

40-
If you'd like to check out the latest updates and watch our progress, we're on the `dev-major`
41-
branch. Our relevant milestones are
40+
**First, v4.0.0-alpha.1 is released.** Book one is largely complete, and we're now focusing on books
41+
two and three. You can find it at the regular spot: https://raytracing.github.io. We are temporarily
42+
preserving the final version of v3.2.3 inside the repo, so you can just grab the latest and
43+
reference both versions.
44+
45+
**Second, Trevor and I are pounding away at the remaining steps to get the final v4.0.0 release done
46+
and published.** We're planning on finishing this work by the end of 2023. If you'd like to check
47+
out the latest updates and watch our progress, we're on the `dev` branch. You can also browse our
48+
release backlog to see what we're planning. Our relevant milestones are
4249

4350
- [v4.0.0](https://github.com/RayTracing/raytracing.github.io/milestone/16)
4451
- [v4.0.0-release](https://github.com/RayTracing/raytracing.github.io/milestone/19)
4552

46-
Let us know if you'd like to help out. If you have a change you'd like to contribute,
47-
_**[please see our contribution guidelines][CONTRIBUTING]**_.
53+
**Third, we're starting to think about where we go from here.** Top of mind topics include shadow
54+
rays, triangle mesh geometry, and parallelism, but there are many possible extensions both large and
55+
small. If you're interested in contributing, email us! You can find our contact info at the head of
56+
each book.
57+
58+
If you'd like to contribute a PR _**please read our [contribution guidelines][CONTRIBUTING]
59+
first**_.
4860

4961

5062
GitHub Discussions
@@ -70,17 +82,16 @@ The organization of this repository is meant to be simple and self-evident at a
7082
- `src/` --
7183
Contains the source.
7284

73-
- `src/common/` --
74-
Contains any headers that are common to two or more books. This is also where external headers
75-
are stored.
76-
7785
- `src/<book>/` --
78-
Contains the source specific to any one book. There is no sharing of source outside of the
79-
common directory.
86+
Contains the final source code for each book.
8087

8188
- `v3/` --
8289
All content (same general structure) for the v3.2.3 release (from December 2020).
8390

91+
- `v3/common` --
92+
Contains v3 headers that are common to two or more v3 books. This is also where external headers
93+
are stored.
94+
8495

8596
Source Code
8697
-----------
@@ -106,10 +117,10 @@ languages (see [_Implementations in Other Languages_][implementations]), and acr
106117
operating systems. Feel free to add your own implementation to the list!
107118

108119
### Branches
109-
The `master` branch contains the latest released (and live) assets. All ongoing development, with
110-
all of the latest changes, can be found in the `dev-patch`, `dev-minor`, and `dev-major` branches.
111-
We try to keep CHANGELOG.md up to date, so you can easily browse what's new in each development
112-
branch.
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.
113124

114125

115126
Building and Running

0 commit comments

Comments
 (0)