duan8/tutorials/contribution.md
Wang Xinyu a5f84f6103
pre-commit check and contribution doc (#1459)
* remove blank

* Update pre-commit.yml

* Update pre-commit.yml

* code style

* add contribution.md

* add contribution.md
2024-03-20 11:13:45 +08:00

731 B

How to make contribution

  1. Fork this repo to your github account

  2. Clone your fork

  3. Create a feature branch

  4. Make changes, including but not limited to create new model, bug fix, documentation, tutorials, etc.

  5. Pre-commit check and push, we use clang-format to do coding style checking, and the coding style is following google c++ coding style with 4-space.

pip install pre-commit
pip install clang-format

cd tensorrtx/
git add [files-to-commit]
pre-commit run

# fix pre-commit errors, then git add files-to-commit again
git add [files-to-commit]

git commit -m "describe your commit"

git push origin [feature-branch]
  1. Submit a pull-request on github web UI to master branch of wang-xinyu/tensorrtx.