Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 3.03 KB

CONTRIBUTING.md

File metadata and controls

47 lines (30 loc) · 3.03 KB

Contributing

First off, thank you for considering contributing.

If you're looking to contribute to this repository, kindly initiate a conversation through an issue, email, or any method that suits you with the repository owners before implementing any changes.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build. Additionally, ensure the code builds cleanly and passes all necessary tests before submitting a pull request.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  4. Please sign all commits as part of the pull request. At a minimum, use Developer Certificate of Origin (DCO). For enhanced security, signing via SSH keys or cosign is preferred.

Code of Conduct

Please note we have a code of conduct, please follow it in all your interactions with the project.

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. As Bill and Ted say, "Be excellent to each other".

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.

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.