In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
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
- Providing help and guidance to newcomers
- Contributing to the project in good faith
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
- Any conduct which could reasonably be considered inappropriate in a professional setting
- Deliberate intimidation, stalking, or following
- Sustained disruption of discussions, talks, or other events
- Spamming or repeatedly posting off-topic content
- Quality over quantity: Focus on meaningful contributions that improve the tool
- Testing: Ensure all contributions include appropriate tests
- Documentation: Update documentation for new features and changes
- Performance: Consider performance implications, especially for large repositories
- Compatibility: Maintain backward compatibility when possible
- Search first: Check existing issues before creating new ones
- Be specific: Provide clear, detailed descriptions of problems or suggestions
- Code examples: Include minimal reproducible examples when reporting bugs
- Patience: Maintainers are volunteers and will respond as time permits
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 with this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
Contributors are expected to:
- Read and follow this Code of Conduct
- Help create a positive and inclusive environment
- Report inappropriate behavior to maintainers
- Focus on what is best for the community
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.
If you experience or witness unacceptable behavior, please contact the project team:
Email: conduct@example.com
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.
- Report: Any community member can report violations to the project team
- Review: Maintainers will review the report privately and objectively
- Action: If the Code of Conduct was violated, appropriate action will be taken
- Follow-up: Maintainers may follow up with involved parties as needed
Consequences for violating the Code of Conduct may include:
- Private warning from the project team
- Temporary or permanent ban from public project spaces
- Removal of access to project resources
- Public statement about the violation (with consent of the reporter)
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq