Skip to content

Latest commit

 

History

History
127 lines (89 loc) · 5.06 KB

contributions.md

File metadata and controls

127 lines (89 loc) · 5.06 KB
Raw

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.

Pull Request Template

Change Summary

Include a detailed summary of the change.

Change Motivation

Include an explanation for the change.

Change Limit

Include an explanation about the regression your change might bring.

Test Info

  • For bug fixes, provide test steps to reproduce your issue.
  • For new features, provide test steps besides unit tests if necessary.

Environment Info Provide the development or test environment info.

  • OS
  • CPU info
  • Python version
  • Dependent component version

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.

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainers at [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4.

For answers to common questions about this code of conduct, see the FAQ page.