Skip to content

Commit

Permalink
Update contribution document (seladb#1590)
Browse files Browse the repository at this point in the history
* update contribution

* remove ruff
  • Loading branch information
tigercosmos authored Sep 25, 2024
1 parent c0e4de6 commit 32ba869
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,14 @@ Every code contribution to this project is highly valued and appreciated. I enco
- PcapPlusPlus compiles successfully on your machine, including all unit-tests and examples
- Unit-tests pass successfully on your machine (both `Tests/Packet++Test` and `Tests/Pcap++Test`)
- All new APIs are well documented using Doxygen (please use @ for keywords)
- 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:
- For Linux (apt) `sudo apt install cppcheck`
- For Windows (using `choco`) `choco install cppcheck --version=2.7`
- For Windows (MSI install): https://github.com/danmar/cppcheck/releases/download/2.7/cppcheck-2.7-x64-Setup.msi
- Build from source: https://github.com/danmar/cppcheck/releases/tag/2.7
- 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:
- `pre-commit`: `pip install pre-commit`
- `cppcheck` (version 2.7 is recommended):
- For Linux (apt) `sudo apt install cppcheck`
- For Windows (using `choco`) `choco install cppcheck --version=2.7`
- For Windows (MSI install): https://github.com/danmar/cppcheck/releases/download/2.7/cppcheck-2.7-x64-Setup.msi
- Build from source: https://github.com/danmar/cppcheck/releases/tag/2.7
- `clang-format`: `pip install clang-format==18.1.6`
- After you commit the code and push it to GitHub, before creating the pull request please make sure that:
- You merge all new code from **dev** to your fork
- CI passes on all platforms
Expand Down

0 comments on commit 32ba869

Please sign in to comment.