Skip to content

CODE_OF_CONDUCT.md

Latest commit

 

History

History
263 lines (169 loc) · 10.8 KB

CODE_OF_CONDUCT.md

File metadata and controls

263 lines (169 loc) · 10.8 KB

Code of Conduct

Our Pledge

We are committed to providing a welcoming and inspiring community for all. Please read and follow our Code of Conduct.

Our Standards

Expected Behavior

  • Be respectful and inclusive: Treat everyone with respect and dignity
  • Use welcoming and inclusive language: Choose words that are inclusive and welcoming
  • Be respectful of differing viewpoints and experiences: Accept that people may have different opinions
  • Gracefully accept constructive criticism: Be open to feedback and suggestions
  • Focus on what is best for the community: Consider the community's best interests
  • Show empathy towards other community members: Be understanding and supportive

Unacceptable Behavior

  • Harassment, trolling, or inappropriate comments: Any form of harassment is not tolerated
  • Personal attacks or political discussions: Keep discussions focused on the project
  • Public or private harassment: Harassment in any form is unacceptable
  • Publishing others' private information without permission: Respect privacy
  • Other conduct that could reasonably be considered inappropriate: Use common sense

Enforcement

Reporting

If you experience or witness unacceptable behavior, please report it by:

  1. Creating a private issue on GitHub
  2. Contacting maintainers directly
  3. Using the community discussion for general concerns

Response

Reports will be reviewed and investigated promptly. We will:

  1. Acknowledge receipt of your report
  2. Investigate the situation thoroughly
  3. Take appropriate action based on the circumstances
  4. Follow up with you about the resolution

Consequences

Unacceptable behavior may result in:

  1. Warning: First offense may result in a warning
  2. Temporary ban: Repeated offenses may result in a temporary ban
  3. Permanent ban: Severe or repeated violations may result in a permanent ban

Scope

This Code of Conduct applies to:

  • All community spaces: GitHub, discussions, issues, pull requests
  • All interactions: Online and offline
  • All participants: Contributors, maintainers, users, and visitors

Enforcement Guidelines

1. Correction

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.

2. Warning

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.

3. Temporary 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.

4. 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.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/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.

Contact Information

Project Maintainers

Community Moderators

  • Moderator 1: Ronin

Reporting Process

  1. Immediate Response: For urgent issues, contact maintainers directly
  2. Issue Creation: For non-urgent issues, create a private GitHub issue
  3. Community Discussion: For general concerns, use the community discussion forum

Response Timeline

  • Acknowledgment: Within 24 hours
  • Investigation: Within 48 hours
  • Resolution: Within 1 week (may vary based on complexity)

Community Guidelines

Communication

  • Be clear and concise: Write clear, understandable messages
  • Use appropriate language: Keep language professional and respectful
  • Stay on topic: Keep discussions relevant to the project
  • Ask questions: Don't hesitate to ask for clarification

Collaboration

  • Be patient: Everyone learns at their own pace
  • Be helpful: Offer assistance when you can
  • Be constructive: Provide constructive feedback
  • Be inclusive: Welcome newcomers and diverse perspectives

Technical Discussions

  • Focus on the code: Keep discussions focused on technical aspects
  • Provide examples: Include code examples when helpful
  • Explain your reasoning: Help others understand your thought process
  • Be open to feedback: Accept constructive criticism gracefully

Diversity and Inclusion

Our Commitment

We are committed to creating a diverse and inclusive community where everyone feels welcome and valued.

What We Value

  • Diverse perspectives: We welcome people from all backgrounds
  • Inclusive environment: We create spaces where everyone can participate
  • Equal opportunity: We provide equal opportunities for contribution
  • Respectful communication: We communicate with respect and empathy

How We Support Diversity

  • Welcoming newcomers: We actively welcome and support new contributors
  • Mentorship: We provide mentorship opportunities
  • Accessibility: We work to make our project accessible to all
  • Inclusive language: We use inclusive language in all communications

Conflict Resolution

When Conflicts Arise

  1. Take a step back: Pause and reflect on the situation
  2. Communicate directly: Try to resolve the issue directly with the person
  3. Seek mediation: If direct communication doesn't work, seek help from moderators
  4. Document the issue: Keep records of the conflict and resolution attempts

Mediation Process

  1. Initial contact: Moderator reaches out to all parties
  2. Information gathering: Moderator collects information from all sides
  3. Mediation session: Moderator facilitates a discussion between parties
  4. Resolution: Parties agree on a resolution
  5. Follow-up: Moderator follows up to ensure resolution is working

Privacy and Confidentiality

What We Protect

  • Personal information: We protect personal information shared in confidence
  • Private communications: We respect the privacy of private communications
  • Sensitive data: We handle sensitive data with care

What We Share

  • Public discussions: Discussions in public forums are visible to all
  • Issue reports: Issue reports may be shared with relevant parties
  • Resolution outcomes: Resolution outcomes may be shared for transparency

Updates to This Code of Conduct

How We Update

  1. Community input: We seek input from the community on proposed changes
  2. Review process: Changes are reviewed by maintainers and moderators
  3. Announcement: Changes are announced to the community
  4. Implementation: Changes are implemented and enforced

Notification Process

  • Major changes: We announce major changes 30 days in advance
  • Minor changes: We announce minor changes 7 days in advance
  • Emergency changes: We announce emergency changes immediately

Enforcement Examples

Positive Examples

  • Welcoming newcomers: "Welcome to the project! I'd be happy to help you get started."
  • Constructive feedback: "I think this approach might work better because..."
  • Acknowledging contributions: "Thanks for your contribution! This is really helpful."
  • Asking for clarification: "Could you clarify what you mean by...?"

Negative Examples

  • Dismissive language: "That's a stupid question."
  • Personal attacks: "You clearly don't know what you're talking about."
  • Inappropriate comments: "This code is garbage."
  • Harassment: Repeated unwanted contact or attention

Resources

Getting Help

  • Documentation: Check project documentation first
  • Community Forum: Ask questions in the community discussion
  • Issue Tracker: Report bugs and request features
  • Direct Contact: Contact maintainers for urgent issues

Learning Resources

External Resources

Conclusion

This Code of Conduct helps us create a welcoming and inclusive community where everyone can contribute effectively. By following these guidelines, we can work together to build something amazing.

Remember: We're all here because we share a common interest in this project. Let's treat each other with respect and kindness, and help each other succeed.

Thank you for being part of our community! 🎉

If you have any questions about this Code of Conduct, please don't hesitate to reach out to our maintainers or moderators.