|
1 | 1 | Contribution Guidelines |
2 | 2 | ======================= |
3 | | - |
4 | | -1. [Pull Request Checklist](#pull-request-checklist) |
5 | | -2. [Pull Request Template](#distillation-support-matrix) |
6 | | -3. [Support](#support) |
7 | | -4. [Contributor Covenant Code of Conduct](#contributor-covenant-code-of-conduct) |
8 | | - |
| 3 | +1. [Create Pull Request](#create-pull-request) |
| 4 | +2. [Pull Request Checklist](#pull-request-checklist) |
| 5 | +3. [Pull Request Template](#distillation-support-matrix) |
| 6 | +4. [Pull Request Acceptance Criteria](#pull-request-acceptance-criteria) |
| 7 | +5. [Pull Request Status Checks Overview](#pull-request-status-checks-overview) |
| 8 | +6. [Support](#support) |
| 9 | +7. [Contributor Covenant Code of Conduct](#contributor-covenant-code-of-conduct) |
| 10 | + |
| 11 | +## Create Pull Request |
9 | 12 | If you have improvements to Intel® Neural Compressor, send your pull requests for |
10 | | -[review](https://github.com/intel/neural-compressor/pulls). If you are new to Github, view the pull request [How To](https://help.github.com/articles/using-pull-requests/). |
| 13 | +[review](https://github.com/intel/neural-compressor/pulls). |
| 14 | +If you are new to GitHub, view the pull request [How To](https://help.github.com/articles/using-pull-requests/). |
| 15 | +### Step-by-Step guidelines |
| 16 | +- Star this repository using the button `Star` in the top right corner. |
| 17 | +- Fork this Repository using the button `Fork` in the top right corner. |
| 18 | +- Clone your forked repository to your pc. |
| 19 | +`git clone "url to your repo"` |
| 20 | +- Create a new branch for your modifications. |
| 21 | +`git checkout -b new-branch` |
| 22 | +- Add your files with `git add -A`, commit `git commit -s -m "This is my commit message"` and push `git push origin new-branch`. |
| 23 | +- Create a [pull request](https://github.com/intel/neural-compressor/pulls). |
11 | 24 |
|
12 | 25 | ## Pull Request Checklist |
13 | 26 |
|
14 | 27 | Before sending your pull requests, follow the information below: |
15 | 28 |
|
16 | 29 | - Changes are consistent with the Python [Coding Style](https://github.com/google/styleguide/blob/gh-pages/pyguide.md). |
17 | | -- Use pylint to check your Python code. |
18 | | -- Use flake8 and autopep8 to make Python code clean. |
19 | 30 | - Add unit tests in [Unit Tests](https://github.com/intel/neural-compressor/tree/master/test) to cover the code you would like to contribute. |
20 | | -- Run [Unit Tests](https://github.com/intel/neural-compressor/tree/master/test). |
21 | | -- Intel® Neural Compressor has adopted the [Developer Certificate of Origin](https://en.wikipedia.org/wiki/Developer_Certificate_of_Origin), you must agree to the terms of Developer Certificate of Origin by signing off each of your commits.`Signed-off-by: Random J Developer <random@developer.example.org>` |
| 31 | +- Intel® Neural Compressor has adopted the [Developer Certificate of Origin](https://en.wikipedia.org/wiki/Developer_Certificate_of_Origin), you must agree to the terms of Developer Certificate of Origin by signing off each of your commits with `-s`, e.g. `git commit -s -m 'This is my commit message'`. |
22 | 32 |
|
23 | 33 | ## Pull Request Template |
24 | 34 |
|
25 | | -**Type of Change** |
26 | | -feature or bug fix or documentation or validation or others |
27 | | -API changed or not |
| 35 | +See [PR template](/.github/pull_request_template.md) |
| 36 | + |
| 37 | +## Pull Request Acceptance Criteria |
| 38 | +- At least two approvals from reviewers |
28 | 39 |
|
29 | | -**Description** |
30 | | -detail description |
31 | | -JIRA ticket: xxx |
| 40 | +- All detected status checks pass |
32 | 41 |
|
33 | | -**Expected Behavior & Potential Risk** |
34 | | -the expected behavior that triggered by this PR |
| 42 | +- All conversations solved |
35 | 43 |
|
36 | | -**How has this PR been tested?** |
37 | | -how to reproduce the test (including hardware information) |
| 44 | +- Third-party dependency license compatible |
38 | 45 |
|
39 | | -**Dependency Change?** |
40 | | -any library dependency introduced or removed |
| 46 | +## Pull Request Status Checks Overview |
| 47 | +Intel® Neural Compressor use [Azure DevOps](https://learn.microsoft.com/en-us/azure/devops/pipelines/?view=azure-devops) for CI test. |
| 48 | +And generally use [Azure Cloud Instance](https://azure.microsoft.com/en-us/pricing/purchase-options/pay-as-you-go) to deploy pipelines, e.g. Standard E16s v5. |
| 49 | +| Test Name | Test Scope | Test Pass Criteria | |
| 50 | +|-------------------------------|-----------------------------------------------|---------------------------| |
| 51 | +| Code Scan | Pylint/Bandit/CopyRight/DocStyle/SpellCheck | PASS | |
| 52 | +| [DCO](https://github.com/apps/dco/) | Use `git commit -s` to sign off | PASS | |
| 53 | +| Unit Test | Pytest scripts under [test](/test) | PASS (No failure, No core dump, No segmentation fault, No coverage drop) | |
| 54 | +| Model Test | Pytorch + TensorFlow + ONNX Runtime + MXNet | PASS (Functionality pass, FP32/INT8 No performance regression) | |
41 | 55 |
|
42 | 56 | ## Support |
43 | 57 |
|
|
0 commit comments