Community Guidelines 🌟

August 29, 2025 · View on GitHub

Welcome to our community! These guidelines help us maintain a positive, inclusive, and productive environment for everyone.

🤝 Our Community Values

Respect

  • Treat everyone with dignity and kindness
  • Value diverse perspectives and experiences
  • Be patient with newcomers and questions

Collaboration

  • Work together towards common goals
  • Share knowledge and help others learn
  • Give constructive feedback

Transparency

  • Communicate openly and honestly
  • Share decisions and reasoning when possible
  • Be clear about expectations and timelines

Excellence

  • Strive for quality in all contributions
  • Take pride in your work
  • Continuously learn and improve

📋 Community Standards

Communication

  • Be Clear: Write clear, concise messages
  • Be Kind: Use friendly, professional language
  • Be Patient: Remember that not everyone has the same experience level
  • Be Helpful: Offer assistance when you can

Participation

  • Stay On Topic: Keep discussions relevant to the project
  • Search First: Check existing issues and discussions before posting
  • Provide Context: Give enough detail for others to understand and help
  • Follow Up: Update or close issues when resolved

Contributions

  • Follow Guidelines: Read and follow our Contributing Guide
  • Test Your Work: Ensure your contributions work as expected
  • Document Changes: Update documentation as needed
  • Respect Decisions: Accept maintainer decisions gracefully

🚫 Unacceptable Behavior

The following behaviors are not tolerated:

  • Harassment: Bullying, threats, or personal attacks
  • Discrimination: Bias based on personal characteristics
  • Spam: Irrelevant or repetitive content
  • Trolling: Deliberately provocative or disruptive behavior
  • Doxxing: Sharing private information without consent
  • Abuse: Misusing community platforms or resources

🔧 Issue and PR Guidelines

Creating Issues

  • Use Templates: Fill out issue templates completely
  • Be Specific: Provide clear steps to reproduce problems
  • One Issue Per Topic: Don't combine multiple unrelated issues
  • Label Appropriately: Add relevant labels to help with triage

Pull Requests

  • Link Issues: Reference related issues in your PR
  • Small Changes: Keep PRs focused and manageable
  • Test Thoroughly: Ensure your changes work correctly
  • Update Documentation: Include relevant documentation updates

Code Review

  • Be Constructive: Offer helpful suggestions, not just criticism
  • Explain Reasoning: Help others understand your feedback
  • Be Timely: Respond to review requests promptly
  • Learn from Feedback: Use reviews as learning opportunities

💬 Discussion Etiquette

Asking Questions

  • Search First: Check if your question has been answered before
  • Be Specific: Provide context and details
  • Show Research: Mention what you've already tried
  • Be Grateful: Thank people who help you

Answering Questions

  • Be Helpful: Provide useful, accurate information
  • Be Patient: Remember everyone is learning
  • Link Resources: Point to relevant documentation or examples
  • Stay Current: Ensure your advice is up-to-date

Discussions

  • Stay Focused: Keep discussions on topic
  • Be Constructive: Aim to move conversations forward
  • Disagree Respectfully: Challenge ideas, not people
  • Know When to Stop: Recognize when discussions have run their course

🎯 Recognition and Rewards

We believe in recognizing valuable contributions:

Recognition Types

  • Contributor Badges: GitHub profile recognition
  • Hall of Fame: Featured in our Contributors page
  • Special Mentions: Called out in release notes
  • Maintainer Invitations: For exceptional ongoing contributors

What We Recognize

  • Code contributions
  • Documentation improvements
  • Bug reports and testing
  • Community support and mentoring
  • Ideas and feature suggestions
  • Event organization and promotion

🆘 Getting Help

Community Support

Reporting Issues

Code of Conduct Violations

🔄 Enforcement

Process

  1. Warning: First violations typically receive a warning
  2. Temporary Restrictions: Repeated violations may result in temporary limits
  3. Permanent Ban: Serious or continued violations may result in permanent exclusion

Appeals

  • Contact opensource@broadsage.com to appeal decisions
  • Provide context and acknowledgment of the issue
  • Appeals are reviewed by the core team

📚 Resources

Documentation

Community Spaces

🌱 Growing Our Community

For New Members

  • Start Small: Begin with simple contributions
  • Ask Questions: Don't hesitate to seek help
  • Observe: Learn from existing community interactions
  • Contribute: Share your unique perspective and skills

For Experienced Members

  • Mentor Others: Help newcomers get started
  • Review Contributions: Provide constructive feedback
  • Share Knowledge: Write documentation and tutorials
  • Lead Initiatives: Propose and drive community projects

📊 Community Health

We monitor community health through:

  • Participation Metrics: Active contributors and engagement levels
  • Response Times: How quickly we address issues and questions
  • Satisfaction Surveys: Regular feedback from community members
  • Diversity Metrics: Ensuring inclusive participation

🎉 Community Events

We regularly organize:

  • Virtual Meetups: Online community gatherings
  • Contribution Drives: Focused efforts on specific goals
  • Hackathons: Collaborative coding events
  • Office Hours: Regular maintainer availability for questions

Stay tuned for announcements in Discussions!

These guidelines are living documents that evolve with our community. Last updated: August 2025

Questions about these guidelines? Start a discussion in our community forum.

Thank you for helping us build a welcoming, productive community! 🚀