add contribution.md

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)

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.