From fb067e46f96986f473987ad717cac097df7f034c Mon Sep 17 00:00:00 2001
From: zhengly123 <zhengly123@outlook.com>
Date: Tue, 13 Sep 2022 14:19:07 +0800
Subject: [PATCH] Add contributor guide

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index d3778328..c09b00e4 100644
--- a/README.md
+++ b/README.md
@@ -7,3 +7,11 @@ source test/script/env_lotus.sh
 mkdir build && cd build
 cmake .. && make -j 12
 ```
+
+## Contributor Guide
+InfiniTensor development is based on the pull request on Github. Before requesting for merging, a PR should satisfy the following requirements
+1. Pass all tests. 
+    1. Currently, CI on Github only checks code format. Script `test/script/clang_format_inplace.sh` is for formatting all code. 
+    2. Contributors should run `ctest` manually and copy its output to the PR. Use fenced code blocks (triple backquotes, i.e., `` ``` ``) to avoid referencing in Github. Otherwise, `#` in the output is interpreted as a Github reference. Do not directly paste the ctest output in commit messages either for the same reason.  
+2. Receive at least one approval from reviewers. 
+3. PR title should be concise since it is going to be the commit message in the main branch after merging and squashing.