Skip to content

Latest commit

 

History

History
73 lines (56 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

73 lines (56 loc) · 3.07 KB
Raw

Contributing

Thanks for your interest in this tool! We are glad you have found it and hope that you can use and improve it. Contributions are welcome!

How to contribute an issue

We welcome issues and enhancement requests on our Issues Tracker.

When reporting an issue, please be as specific as possible including:

  • Python version & OS
  • Error message(s) encountered (if any)
  • Configuration values

If you have a problem using our tool, please open an issue!

How to contribute code

We use a Pull Request process with a required review from a maintainer.

Before submitting your pull request, consider the following questions:

  • Has the documentation been updated to support this change?
  • Is the change backward-compatible to older configuration files?
  • Are new dependencies introduced, and are they included in the requirements.txt?
  • Does the change introduce complexity for novice users? Are optional features clearly marked optional?
  • Are debugging print statements removed?
  • Does the change use descriptive variable names?

Please also review the commits:

  • Include an issue number in the commit name, to link the commit, issue, and pull request
  • Include a descriptive message
  • Sign the commits to certify your Developer Certificate of Origin (DCO)

For example use: git commit -sm "#issue_number - <your message here>"

Code of Conduct

Our Pledge

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

Our Standards

Examples of behavior that contributes to a positive environment for our community include:

  • Demonstrating empathy and kindness toward other people
  • Being respectful of differing opinions, viewpoints, and experiences
  • Giving and gracefully accepting constructive feedback
  • Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
  • Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

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

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.