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.
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
- Using welcoming and inclusive language
- Being patient with newcomers and those learning
- Providing helpful and constructive code reviews
- Celebrating diverse contributions and perspectives
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
- Conduct which could reasonably be considered inappropriate in a professional setting
- Dismissing or attacking inclusion-oriented requests
- Sustained disruption of community spaces or events
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
This Code of Conduct also applies to actions taken outside of these spaces when they have a negative impact on community health.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement through:
- GitHub Issues for this repository
- Direct message to repository maintainers
- Email to the project maintainers (if provided)
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
Community Impact: A violation through a single incident or series of actions.
Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
Consequence: A permanent ban from any sort of public interaction within the community.
When reviewing code:
- Focus on the code, not the person
- Provide specific, actionable feedback
- Explain the reasoning behind suggestions
- Acknowledge good practices and improvements
- Be patient with different skill levels
- Ask questions rather than making demands
When receiving reviews:
- Remember that reviewers are trying to help
- Don't take criticism personally
- Ask for clarification if feedback is unclear
- Be open to different approaches
- Thank reviewers for their time
- Search for existing issues before creating new ones
- Use clear, descriptive titles
- Provide context and details
- Be respectful of different viewpoints
- Stay on topic
- Don't spam or cross-post excessively
- Always give credit where credit is due
- Don't claim others' work as your own
- Respect intellectual property and licenses
- Acknowledge contributions appropriately
We are committed to providing a welcoming and inclusive environment for all contributors. We recognize that:
- People have different levels of experience and expertise
- Everyone starts somewhere and deserves respect while learning
- Different perspectives and approaches can improve projects
- Diversity strengthens our community
- Everyone has something valuable to contribute
If you experience or witness unacceptable behavior, or have any other concerns, please report it by:
- For code-related issues: Open a GitHub issue describing the problem
- For community conduct issues: Contact the project maintainers directly
- For sensitive matters: Use private communication channels
When reporting, please include:
- Your contact information
- Names (real, usernames, or pseudonyms) of any individuals involved
- Description of the incident and whether it's ongoing
- Any additional context or information
- Links to relevant conversations or commits
All reports will be handled with discretion and confidentiality.
- Acknowledgment: Within 48 hours
- Initial review: Within 1 week
- Resolution: Varies based on complexity, but updates will be provided
If you believe you have been unfairly accused of violating this Code of Conduct, you may appeal the decision by contacting the project maintainers with a concise description of your grievance. Appeals will be reviewed by uninvolved community leaders.
If you have questions about this Code of Conduct, please:
- Open a discussion on GitHub
- Contact the maintainers
- Review the CONTRIBUTING.md for additional guidelines
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.
Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder.
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
This Code of Conduct may be updated periodically. When substantive changes are made, we will:
- Announce the changes in the repository
- Provide a reasonable period for community feedback
- Document the history of changes
The current version will always be available in this file in the repository.
Last Updated: December 2024
Version: 1.0
Thank you for helping make this a welcoming, friendly community for everyone! 🎉