Skip to content

Commit 32ba869

Browse files
authored
Update contribution document (#1590)
* update contribution * remove ruff
1 parent c0e4de6 commit 32ba869

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,14 @@ Every code contribution to this project is highly valued and appreciated. I enco
2222
- PcapPlusPlus compiles successfully on your machine, including all unit-tests and examples
2323
- Unit-tests pass successfully on your machine (both `Tests/Packet++Test` and `Tests/Pcap++Test`)
2424
- All new APIs are well documented using Doxygen (please use @ for keywords)
25-
- Make sure that pre-commit hooks are passing by using `pre-commit run --all-files`. For pre-commit hooks you need to install `cppcheck` on your system. Recommended and tested version is 2.7. You can install by using:
26-
- For Linux (apt) `sudo apt install cppcheck`
27-
- For Windows (using `choco`) `choco install cppcheck --version=2.7`
28-
- For Windows (MSI install): https://github.com/danmar/cppcheck/releases/download/2.7/cppcheck-2.7-x64-Setup.msi
29-
- Build from source: https://github.com/danmar/cppcheck/releases/tag/2.7
25+
- Make sure that pre-commit hooks are passing by using `pre-commit run --all-files`. For pre-commit hooks you need to install `cppcheck` and `clang-format` on your system. You can install them using the following commands:
26+
- `pre-commit`: `pip install pre-commit`
27+
- `cppcheck` (version 2.7 is recommended):
28+
- For Linux (apt) `sudo apt install cppcheck`
29+
- For Windows (using `choco`) `choco install cppcheck --version=2.7`
30+
- For Windows (MSI install): https://github.com/danmar/cppcheck/releases/download/2.7/cppcheck-2.7-x64-Setup.msi
31+
- Build from source: https://github.com/danmar/cppcheck/releases/tag/2.7
32+
- `clang-format`: `pip install clang-format==18.1.6`
3033
- After you commit the code and push it to GitHub, before creating the pull request please make sure that:
3134
- You merge all new code from **dev** to your fork
3235
- CI passes on all platforms

0 commit comments

Comments
 (0)