This document is split up and organised into several sections to aid reading and linking. For small changes like one-line fixes or minor tweaks then you can just read the quick start section below.
Don't worry about reading all of these documents end-to-end and getting everything perfect the first time. The point of this information isn't to be restrictive about rules and reject contributions, but to give people guidance and help about how to contribute. I'm happy to help out with any changes needed to get your PR ready to merge, until you get the hang of things. If you're unfamiliar with git and need help making any changes, feel free to ask as well!
If you're a regular contributor or if you have a larger amount of code to change, please do read through these as it will make life easier for everyone if you to follow along with these guidelines from the start.
I want to ensure that anyone can contribute to RenderDoc with only the next bug to worry about. For that reason the project has adopted the contributor covenent as a code of conduct to be enforced for anyone taking part in RenderDoc development. This includes any comments on issues or any public discussion e.g. in the #renderdoc IRC channel or discord server.
If you have any queries or concerns in this regard you can get in touch with me directly over email.
RenderDoc is a tool intended for debugging your own projects and programs, those to which you have true ownership of. Use and abuse of RenderDoc for illegal or unethical uses including but not limited to capturing copyrighted programs that you do not own the rights to will not be tolerated. Any questions or issues related to any such use will not be answered and no support will be provided.
Any code you submit will become part of the repository and be distributed under the RenderDoc license. By submitting code to the project you agree that the code is your own work and that you have the ability to give it to the project.
You also agree by submitting your code that you grant all transferrable rights to the code to the project maintainer, including for example re-licensing the code, modifying the code, distributing in source or binary forms. Specifically this includes a requirement that you assign copyright to the project maintainer (Baldur Karlsson). For this reason, do not modify any copyright statements in files in any PRs.
- Dependencies
- Compiling
- Preparing commits
- Developing a change
- Testing
- Code Explanation
- Filing issues
- Asking Questions
The two things you'll need to bear in mind for a small change are the commit message and code formatting.
Commit messages should have a first line with a maximum of 72 characters, then a gap, then if you need it a longer explanation in any format you want. The reason for this is that limiting the first line to 72 characters means that git log and github's history always displays the full message without it being truncated.
For more information, check the section about commit messages.
Code should be formatted using clang-format 15.0. The reason we fix a specific version of clang-format is that unfortunately different versions can format code in different ways using the same config file, so this would cause problems with automatic verification of code formatting.
For more information, check the section about code formatting.