add CI and owner

Signed-off-by: Wenxin Zhang <wenxin.zhang@intel.com>
intel · Aug 11, 2023 · 4038579 · 4038579
1 parent 7dfbff0
commit 4038579
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 24 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -6,7 +6,6 @@ API changed or not
 ## Description
 
 detail description 
-JIRA ticket: xxx
 
 ## Expected Behavior & Potential Risk
 

diff --git a/docs/CI_introduction.md b/docs/CI_introduction.md
@@ -0,0 +1,17 @@
+# CI Introduction
+Intel Extension for Transformers use Github Action (GHA) for CI test, if you are new to GHA, please refer to [GHA](https://docs.github.com/en/actions)
+All the test scripts will be maintained under [.github](../.github/workflows).
+
+
+
+|     Test Name                 |     Test Pass Criteria                        |     Checks    |
+|-------------------------------|-----------------------------------------------|---------------|
+|     Format Scan               |     Pylint/Cpplint/bandit/cloc Pass           |     4         |
+|     Spell Check               |     Check Pass                                |     1         |
+|     Copyright Check           |     Add License on top of code/scripts        |     1         |
+|     DCO                       |     Use git commit -s to signoff              |     1         |
+|     Unit Test    |     a. No failure, no core dump, no segmentation fault b. No coverage drop|     5         |
+|     Kernel Benchmark          |     No failure, No performance regression              |     1         |
+|     Model Test       |     a. Fp32/Int8 inference no regression  b. API no fucntionality success |     5         |
+|     CPP Graph Test            |     No failure, No performance regression      |     1         |
+
diff --git a/docs/component_owner.md b/docs/component_owner.md
@@ -0,0 +1,14 @@
+# Module Owner Matrix
+Here is the matrix of first/second owners for each component in Intel Extension for Transformers. 
+
+Contributions to Intel Extension for Transformers specific component must get approval from the owners
+
+|     Component      |     Owner       |     Backup      |
+|--------------------|-----------------|-----------------|
+|     Kernel         |     Hengyu      |     Luo yu      |
+|     Engine         |     Dong bo     |     Zhenwei     |
+|     Pytorch        |     Penghui     |     He xin      |
+|     Tensorflow     |     Lv liang    |     Penghui     |
+|     Neuralchat     |     Lv liang    |     Kaokao      |
+|     Workflow       |     Lv liang    |     Haihao      |
+|     Tests          |     Wenxin      |     Xuehao      |
diff --git a/docs/contributions.md b/docs/contributions.md
@@ -30,45 +30,29 @@ If you have improvements to Intel® Extension for Transformers, pull requests fo
 Before sending your pull requests, follow the information below:
 
 - Changes are consistent with the Python [Coding Style](https://github.com/google/styleguide/blob/gh-pages/pyguide.md).
-- Use pylint to check your Python code.
-- Use flake8 and autopep8 to make Python code clean.
+- Use pylint to check your Python code, more detail please go to [pylint script](../.github/workflows/script/formatScan/pylint.sh)
 
 ### Pull Request Template
 See [PR template](../.github/PULL_REQUEST_TEMPLATE/pull_request_template.md)
 
 ### Pull Request Acceptance Criteria
 
-(1) At least two approval from reviewers (1 approval from the component [owner](../.github/CODEOWNERS))
+(1) At least two approvals from reviewers (1 approval from the component [owner](./component_owner.md))
 
 (2) ALL detected CI checks pass
 
-(3) ALL conversation solved
-
-
-## CI Introduction
+(3) ALL conversations solved
 
+(4) Third-party dependency license compliable
 
 
-|     Test Name                 |     Test Pass Criteria                        |     Checks    |
-|-------------------------------|-----------------------------------------------|---------------|
-|     Format Scan               |     Pylint/Cpplint/bandit/cloc Pass           |     4         |
-|     Spell Check               |     Check Pass                                |     1         |
-|     Copyright Check           |     Check Pass                                |     1         |
-|     DCO                       |     Check Pass                                |     1         |
-|     Optimize UT + Coverage    |     a. No failure, no core dump, no segmentation fault b. No coverage drop|     1         |
-|     Engine UT + Coverage      |     a. No failure, no core dump, no segmentation fault b. No coverage drop|     3         |
-|     Kernel UT                 |     No failure, no core dump, no segmentation fault   |     1         |
-|     Kernel Benchmark          |     No failure, No performance regression              |     1         |
-|     Optimize Model Test       |     a. Quantize success  b. Fp32 Benchmark/Throughput/Accuracy success and no regression  c. Int8 Benchmark/Throughput/Accuracy success and no regression|     2         |
-|     Backend Model Test        |     a. Fp32 inference no regression   b. Int8 inference no regression  c. C++ API inference no regression|     2         |
-|     LLM Test                  |     No failure, No performance regression      |     1         |
-|     CPP Graph Test            |     No failure, No performance regression      |     1         |
-
+## CI Introduction
+See [CI Introduction](./CI_introduction.md)
 
 ## FAQ
 
 
-1. How to add third-party dependency
+1. How to check third-party dependency license compliance
 
     If you are using third-party component by: (1) import lib and uses its API (2) static/dynamic linked (3) copy code and modified (4) other uncertain usage, please contact [Maintainers](inc.maintainers@intel.com) to check license compliance before push code to repo.