Skip to content

Commit 5f51577

Browse files
committed
add contributors guide
1 parent 6e469c6 commit 5f51577

File tree

3 files changed

+25
-10
lines changed

3 files changed

+25
-10
lines changed

.github/pull_request_template.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!--
2-
You must run clang-format, otherwise your change may not pass the tests on CI
3-
We recommend using pre-commit.
2+
## Instructions
43
5-
To use:
6-
pre-commit run -a
7-
Or:
8-
pre-commit install # (runs every time you commit in git)
4+
- Unless your code is self explaining, add comments.
5+
- Consider if your proposed changes introduces API, ABI, back-compatibility or behavioral changes.
6+
- If your code is fixing a bug, please create a unit test to reproduce the bug, i.e. a test that fails before the fix and pass after the fix.
7+
- You use [pre-commit](https://pre-commit.com/) to apply automatically all the required linting rules (clang-format in particular).
8+
- You should also execute the script `./run_clang_tidy.sh` and correct all the warnings.
99
10-
See https://github.com/pre-commit/pre-commit
10+
Please read the CONTRIBUTORS_GUIDE.md file for details and instructions.
1111
-->

CONTRIBUTORS_GUIDE.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Contributors Guide
2+
3+
Before submitting a Pull Request, please follow these instructions:
4+
5+
- Unless your code is self explaining, add comments.
6+
- Consider if your proposed change introduces API, ABI, back-compatibility or behavioral changes.
7+
- If your code is fixing a bug, please create a unit test to reproduce the bug, i.e. a test that fails before the fix and pass after the fix.
8+
- You use [pre-commit](https://pre-commit.com/) to apply automatically all the required linting rules (clang-format in particular).
9+
- You should also execute the script `./run_clang_tidy.sh` and correct all the warnings.
10+
11+
You will need to install the latest **clang-tidy-21** as follows:
12+
13+
```
14+
wget https://apt.llvm.org/llvm.sh
15+
chmod +x llvm.sh
16+
sudo ./llvm.sh 21
17+
sudo apt install clangd-21 clang-tidy-21
18+
```

run_clang_format.sh

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)