[doc] update CONTRIBUTING.md (wenet-e2e#183)

* [doc] update CONTRIBUTING.md * add pics
SuperReally · Feb 24, 2021 · a67082a · a67082a
1 parent 55f1f37
commit a67082a
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,10 +4,33 @@
 
 You'll need to install flake8 first.
 
+`pip install flake8==3.8.2`
+
 We use flake8 to perform additional formatting and semantic checking of code.
 We provide a pre-commit git hook for performing these checks, before a commit
 is created:
 
 ```bash
 ln -s ../../tools/git-pre-commit .git/hooks/pre-commit
 ```
+
+You have to execute above command in wenet project root directory.
+After that, each commit will be checked by flake8.
+
+If you do not set pre-commit, just run `flake8` in wenet project root directory
+and fix all the problems.
+
+## Github checks
+
+After a pull request is submitted, some checks will run to check your code style.
+
+Below is an example where some checks fail.
+
+![github checks](docs/images/checks.png)
+
+You need to click the details to see the detailed info like the example below.
+
+![github checks](docs/images/check_detail.png)
+
+You have to fix all style problems according to the detailed info.
+
diff --git a/docs/images/check_detail.png b/docs/images/check_detail.png
diff --git a/docs/images/checks.png b/docs/images/checks.png