From d6497ed659bbb68cddb8948e013e192aeec8806b Mon Sep 17 00:00:00 2001 From: VincyZhang Date: Fri, 11 Aug 2023 14:26:52 +0800 Subject: [PATCH] update contricution.md (#121) * update contricution.md Signed-off-by: Wenxin Zhang * fix spelling Signed-off-by: Wenxin Zhang * add CI and owner Signed-off-by: Wenxin Zhang * update owner and CI Signed-off-by: Wenxin Zhang * Use the mailto and remove unused info Signed-off-by: hshen14 --------- Signed-off-by: Wenxin Zhang Signed-off-by: hshen14 Co-authored-by: Haihao Shen --- .../pull_request_template.md | 1 - .../workflows/script/formatScan/nlp_dict.txt | 29 ++++++++- docs/CI_introduction.md | 29 +++++++++ docs/component_owner.md | 14 ++++ docs/contributions.md | 64 +++++++++++++------ 5 files changed, 114 insertions(+), 23 deletions(-) create mode 100644 docs/CI_introduction.md create mode 100644 docs/component_owner.md diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index c28d1c790c0..4181ee3c288 100644 --- 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/.github/workflows/script/formatScan/nlp_dict.txt b/.github/workflows/script/formatScan/nlp_dict.txt index 40b782bc4af..3f9feca7c43 100644 --- a/.github/workflows/script/formatScan/nlp_dict.txt +++ b/.github/workflows/script/formatScan/nlp_dict.txt @@ -2256,4 +2256,31 @@ ChatLLAMA ChatMPT LLM MPT -mailto \ No newline at end of file +mailto +CODEOWNERS +Cpplint +DCO +cloc +jira +servicedesk +Bas +GHA +clangformat +dco +gtest +inteltf +jenk +mr +sign off +formatScan +Neuralchat +PenghuiCheng +VincyZhang +XuehaoSun +airMeng +kevinintel +lkk +luoyu +lvliang +xin +zhenwei \ No newline at end of file diff --git a/docs/CI_introduction.md b/docs/CI_introduction.md new file mode 100644 index 00000000000..7c815dbc460 --- /dev/null +++ b/docs/CI_introduction.md @@ -0,0 +1,29 @@ +# 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) + + +Generally We use [Azure Cloud](https://azure.microsoft.com/en-us/pricing/purchase-options/pay-as-you-go) to deploy CI on Es-v5, Bas-v2. + + +| Test Name | Test Scope | Test Pass Criteria | +|-------------------------------|-----------------------------------------------|---------------| +| Format Scan | Pylint/Cpplint/bandit/cloc/clangformat Pass | PASS | +| Spell Check | Spelling Check | PASS | +| Copyright Check | Copyright Check | PASS | +| [DCO](https://github.com/apps/dco/) | Use git commit -s to sign off | PASS | +| Unit Test | pytest + coverage + gtest | PASS(No failure, No core dump, No segmentation fault, No coverage drop) | +| Kernel Benchmark | Benchmark [Details](../intel_extension_for_transformers/backends/neural_engine/test/kernels/benchmark) | PASS(No performance regression) | +| Model Test | Pytorch + Tensorflow + Neural Engine + IPEX + CPP Graph | PASS(FP32/INT8 No performance regression) | + +# FAQ +1. How to add examples + + (1) Still need to pass detected CI tests + + (2) Use [Extension Test](https://inteltf-jenk.sh.intel.com/view/nlp-toolkit-validation/job/nlp-toolkit-validation-top-mr-extension/) to cover new examples. If you do not have permission for extension test, please contact [Maintainers](inc.maintainers@intel.com) + + +2. How to test specific component version + + (1) Use [Extension Test](https://inteltf-jenk.sh.intel.com/view/nlp-toolkit-validation/job/nlp-toolkit-validation-top-mr-extension/) to specify the version. If you do not have permission for extension test, please contact [Maintainers](inc.maintainers@intel.com) + diff --git a/docs/component_owner.md b/docs/component_owner.md new file mode 100644 index 00000000000..def3055c9eb --- /dev/null +++ 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 | airMeng | luoyu-intel | +| Engine | a32543254 | zhenwei-intel | +| Pytorch | PenghuiCheng | xin3he | +| Tensorflow | lvliang-intel | PenghuiCheng | +| Neuralchat | lvliang-intel | lkk12014402 | +| Workflow | lvliang-intel | kevinintel | +| Tests | VincyZhang | XuehaoSun | \ No newline at end of file diff --git a/docs/contributions.md b/docs/contributions.md index a854726c622..60a0f507334 100644 --- a/docs/contributions.md +++ b/docs/contributions.md @@ -1,45 +1,67 @@ Contribution Guidelines ======================= -1. [Pull Request Checklist](#pull-request-checklist) -2. [Pull Request Template](#distillation-support-matrix) -3. [Support](#support) -4. [Contributor Covenant Code of Conduct](#contributor-covenant-code-of-conduct) +1. [General](#General) + + 1.1 [Pull Request Checklist](#pull-request-checklist) + + 1.2 [Pull Request Template](#pull-request-template) + + 1.3 [Pull Request Acceptance Criteria](#pull-request-acceptance-criteria) + +2. [CI Introduction](#ci-introduction) + +3. [FAQ](#faq) + +4. [Support](#support) + +5. [Contributor Covenant Code of Conduct](#contributor-covenant-code-of-conduct) + + +## General If you have improvements to Intel® Extension for Transformers, pull requests for [review](https://github.com/intel/intel-extension-for-transformers/pulls). If you are new to Github, view the pull request [How To](https://help.github.com/articles/using-pull-requests/). -## Pull Request Checklist + +### Pull Request Checklist + 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 approvals from reviewers (1 approval from the component [owner](./component_owner.md)) -## Pull Request Template +(2) ALL detected CI checks pass -**Type of Change** -feature or bug fix or documentation or validation or others -API changed or not +(3) ALL conversations solved -**Description** -detail description -JIRA ticket: xxx +(4) Third-party dependency license Compatible -**Expected Behavior & Potential Risk** -the expected behavior that triggered by this PR -**How has this PR been tested?** -how to reproduce the test (including hardware information) +## CI Introduction +See [CI Introduction](./CI_introduction.md) + +## FAQ + + +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](mailto:inc.maintainers@intel.com) to check license compliance before push code to repo. -**Dependency Change?** -any library dependency introduced or removed ## Support Submit your questions, feature requests, and bug reports to the -[GitHub issues](https://github.com/intel/intel-extension-for-transformers/issues) page. You may also reach out to [Maintainers](inc.maintainers@intel.com). +[GitHub issues](https://github.com/intel/intel-extension-for-transformers/issues) page. You may also reach out to [Maintainers](mailto:inc.maintainers@intel.com). + ## Contributor Covenant Code of Conduct