pre-commit check and contribution doc (wang-xinyu#1459)

* remove blank

* Update pre-commit.yml

* Update pre-commit.yml

* code style

* add contribution.md

* add contribution.md

.github/workflows/pre-commit.yml

@@ -10,6 +10,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
+      with:
+        # grab the history of the PR
+        fetch-depth: 0
     - uses: actions/setup-python@v3
     - uses: pre-commit/[email protected]
       with:

README.md

@@ -33,6 +33,7 @@ The basic workflow of TensorRTx is:
 
 ## Tutorials
 
+- [How to make contribution](./tutorials/contribution.md)
 - [Install the dependencies.](./tutorials/install.md)
 - [A guide for quickly getting started, taking lenet5 as a demo.](./tutorials/getting_started.md)
 - [The .wts file content format](./tutorials/getting_started.md#the-wts-content-format)
@@ -145,7 +146,7 @@ Some tricky operations encountered in these models, already solved, but might ha
 | YOLOv3-spp(darknet53) | Xeon E5-2620/GTX1080 | 1 | FP32 | 608x608 | 38.5 |
 | YOLOv4(CSPDarknet53) | Xeon E5-2620/GTX1080 | 1 | FP32 | 608x608 | 35.7 |
 | YOLOv4(CSPDarknet53) | Xeon E5-2620/GTX1080 | 4 | FP32 | 608x608 | 40.9 |
-| YOLOv4(CSPDarknet53) | Xeon E5-2620/GTX1080 | 8 | FP32 | 608x608 | 41.3 | 
+| YOLOv4(CSPDarknet53) | Xeon E5-2620/GTX1080 | 8 | FP32 | 608x608 | 41.3 |
 | YOLOv5-s v3.0 | Xeon E5-2620/GTX1080 | 1 | FP32 | 608x608 | 142 |
 | YOLOv5-s v3.0 | Xeon E5-2620/GTX1080 | 4 | FP32 | 608x608 | 173 |
 | YOLOv5-s v3.0 | Xeon E5-2620/GTX1080 | 8 | FP32 | 608x608 | 190 |

tutorials/contribution.md

@@ -0,0 +1,29 @@
+# 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]
+```
+
+6. Submit a pull-request on github web UI to master branch of wang-xinyu/tensorrtx.