Contribution Guidelines¶
If you have improvements to Intel® Neural Compressor, send your pull requests for review. If you are new to Github, view the pull request How To.
Pull Request Checklist¶
Before sending your pull requests, follow the information below:
Changes are consistent with the Python Coding Style.
Use pylint to check your Python code.
Use flake8 and autopep8 to make Python code clean.
Add unit tests in Unit Tests to cover the code you would like to contribute.
Run Unit Tests.
Intel® Neural Compressor has adopted the 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>
Pull Request Template¶
Type of Change feature or bug fix or documentation or validation or others API changed or not
Description detail description JIRA ticket: xxx
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)
Dependency Change? any library dependency introduced or removed
Support¶
Submit your questions, feature requests, and bug reports to the GitHub issues page. You may also reach out to Maintainers.
Contributor Covenant Code of Conduct¶
This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant Code of Conduct.