Skip to content

Commit

Permalink
Update README + CONTRIBUTING post v4-alpha
Browse files Browse the repository at this point in the history
  • Loading branch information
hollasch committed Aug 11, 2023
1 parent 9d4e978 commit 5aceff5
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 25 deletions.
25 changes: 17 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,12 @@ improvements.
Development Branches
---------------------
We use `master` as our release branch. _Generally, changes should never go directly to the master
branch_. All ongoing development work (and all of the latest changes) will be in the `dev-patch`,
`dev-minor`, or `dev-major` branches. The appropriate target branch for any pull requests you want
to make will be determined in the associated issue first (all PRs should have an associated issue).
branch_. All ongoing development work (and all of the latest changes) will be in the `dev` branch.
However, we may want changes in other development branches (for example, in a `dev-patch` branch for
a quick patch release). The appropriate target branch for any pull requests you want to make will be
determined in the associated issue first (all PRs should have an associated issue).

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


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

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


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

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

5. Follow the existing code style.

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

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

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

Note the code philosophy outlined in the first section of the first book. In short, the code is
intended to be clear for everyone, using simple C/C++ idioms as much as possible. We have chosen to
adopt _some_ modern conventions where we feel it makes the code more accessible to non-C++
programmers. Please follow the existing coding style and simplicity when offering your suggested
changes.

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


Questions
Expand Down
45 changes: 28 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,18 +33,30 @@ versions, use the print function in your browser.

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

If you'd like to check out the latest updates and watch our progress, we're on the `dev-major`
branch. Our relevant milestones are
**First, v4.0.0-alpha.1 is released.** Book one is largely complete, and we're now focusing on books
two and three. You can find it at the regular spot: https://raytracing.github.io. We are temporarily
preserving the final version of v3.2.3 inside the repo, so you can just grab the latest and
reference both versions.

**Second, Trevor and I are pounding away at the remaining steps to get the final v4.0.0 release done
and published.** We're planning on finishing this work by the end of 2023. If you'd like to check
out the latest updates and watch our progress, we're on the `dev` branch. You can also browse our
release backlog to see what we're planning. Our relevant milestones are

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

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

If you'd like to contribute a PR _**please read our [contribution guidelines][CONTRIBUTING]
first**_.


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

- `src/common/` --
Contains any headers that are common to two or more books. This is also where external headers
are stored.

- `src/<book>/` --
Contains the source specific to any one book. There is no sharing of source outside of the
common directory.
Contains the final source code for each book.

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

- `v3/common` --
Contains v3 headers that are common to two or more v3 books. This is also where external headers
are stored.


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

### Branches
The `master` branch contains the latest released (and live) assets. All ongoing development, with
all of the latest changes, can be found in the `dev-patch`, `dev-minor`, and `dev-major` branches.
We try to keep CHANGELOG.md up to date, so you can easily browse what's new in each development
branch.
The `master` branch contains the latest released (and live) assets. In general, ongoing development,
with all of the latest changes, can be found in the `dev` branch, which may contain patch, minor and
major changes, depending on the release in progress. We try to keep CHANGELOG.md up to date, so you
can easily browse what's new in each development branch.


Building and Running
Expand Down

0 comments on commit 5aceff5

Please sign in to comment.