diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 838c8fd5..f8d86251 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,7 +14,18 @@ appropriate test coverage. For code to be accepted, all tests must pass; the global test suite is `["@", "just tests", "", "ALL"]`. Code is formatted with `clang-format` and linted with `clang-tidy`; the corresponding configuration files can be found in the top-level -directory of this repository. +directory of this repository. The top-level lint target is +`["@", "lint", "", ""]`; formatting issues can be fixed by building +and applying the patch `["@", "lint", "", "format.diff"]`. + +*NOTE:* In order for everyone to use the same version of the linting +tools, the `"lint"` repository +[bootstraps](https://github.com/just-buildsystem/bootstrappable-toolchain) +the required tools; the configuration variable `"TOOLCHAIN_CONFIG"` +is honored. As a consequence, (transitively) depending on the +`"lint"` repository pulls in quite some sources and linting the +first time requires a significant amount of time to build the tools +from first principles. Changes should be organized as a patch series, i.e., as a sequence of small changes that are easy to review, but nevertheless self-contained |