succinctly 0.1.0

High-performance succinct data structures for Rust
Documentation
# Code of Conduct

## Our Pledge

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.

## Our Standards

Examples of behavior that contributes to a positive environment for our community include:

* **Being Respectful**: Using welcoming and inclusive language, being respectful of differing viewpoints and experiences
* **Being Collaborative**: Gracefully accepting constructive criticism, focusing on what is best for the community
* **Being Empathetic**: Showing empathy towards other community members
* **Being Professional**: Maintaining professionalism in all interactions
* **Being Supportive**: Helping newcomers and encouraging participation
* **Being Patient**: Understanding that people have different skill levels and backgrounds
* **Being Constructive**: Providing helpful feedback and suggestions

Examples of unacceptable behavior include:

* **Harassment**: 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
* **Discrimination**: Public or private harassment based on any protected characteristic
* **Privacy Violations**: Publishing others' private information, such as a physical or email address, without their explicit permission
* **Inappropriate Conduct**: Other conduct which could reasonably be considered inappropriate in a professional setting
* **Spam**: Excessive promotion, off-topic discussions, or repetitive content

## Community Responsibilities

### For All Community Members

* **Participate Constructively**: Contribute positively to discussions and development
* **Follow Guidelines**: Adhere to technical guidelines and contribution standards
* **Respect Decisions**: Accept maintainer decisions gracefully, even when you disagree
* **Help Others**: Assist newcomers and share knowledge
* **Report Issues**: Report violations of this code of conduct promptly

### For Contributors

* **Quality First**: Submit high-quality contributions that meet project standards
* **Documentation**: Provide clear documentation for your contributions
* **Testing**: Ensure your contributions are well-tested
* **Communication**: Communicate clearly about your changes and intentions
* **Feedback**: Accept and incorporate feedback constructively

### For Maintainers

* **Fair Review**: Review contributions fairly and constructively
* **Clear Communication**: Provide clear feedback and guidance
* **Timely Response**: Respond to issues and pull requests in a reasonable timeframe
* **Consistent Standards**: Apply standards consistently across all contributions
* **Community Building**: Foster an inclusive and welcoming community

## Scope

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 e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

### Community Spaces Include

* GitHub repository (issues, pull requests, discussions, releases)
* Project documentation and wikis
* Community chat channels or forums
* Project-related social media accounts
* Conference presentations and talks about the project
* Any other official project communication channels

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening a GitHub issue or contacting the maintainers through GitHub. All complaints will be reviewed and investigated promptly and fairly.

### Enforcement Process

1. **Report**: Community members can report violations through:
   - Opening a GitHub issue
   - GitHub's reporting features
   - Contacting maintainers through GitHub

2. **Investigation**: The maintainer team will:
   - Review the report promptly (within 48 hours)
   - Investigate the incident thoroughly
   - Maintain confidentiality during the process
   - Document findings and decisions

3. **Response**: Based on the investigation, responses may include:
   - Private discussion with involved parties
   - Public clarification of community standards
   - Temporary or permanent ban from community spaces
   - Referral to appropriate authorities if necessary

### Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

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

## Community Values

### Technical Excellence
* We strive for high-quality, well-tested, and well-documented code
* We value performance, security, and reliability
* We encourage learning and knowledge sharing
* We support evidence-based technical decisions

### Inclusivity and Diversity
* We welcome contributors from all backgrounds and skill levels
* We provide mentorship and support for newcomers
* We value diverse perspectives and experiences
* We work to remove barriers to participation

### Transparency and Openness
* We conduct development in the open
* We document decisions and rationale
* We welcome feedback and suggestions
* We maintain open communication channels

### Collaboration and Community
* We work together toward common goals
* We respect different working styles and preferences
* We support each other's growth and success
* We celebrate achievements and contributions

## Resources and Support

### Getting Help
* **Technical Questions**: Use GitHub Discussions or issues
* **Community Questions**: Reach out to maintainers
* **Code of Conduct Issues**: Open a GitHub issue or contact maintainers through GitHub

### Learning Resources
* [Contributing Guidelines]CONTRIBUTING.md
* [Developer Guide]docs/DEVELOPER_GUIDE.md
* [User Guide]docs/USER_GUIDE.md
* [Project Architecture]CLAUDE.md

### Mental Health and Well-being
We recognize that contributing to open source can be stressful. If you're experiencing difficulties:
* Take breaks when needed
* Reach out for support
* Remember that this is voluntary work
* Prioritize your health and well-being

## Acknowledgment

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](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](https://github.com/mozilla/diversity).

For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).

## Contact Information

For questions about this Code of Conduct or to report violations:

* **Primary Contact**: Project Maintainers via GitHub
* **Repository**: [https://github.com/rust-works/succinctly]https://github.com/rust-works/succinctly
* **Issues**: [https://github.com/rust-works/succinctly/issues]https://github.com/rust-works/succinctly/issues
* **Discussions**: [https://github.com/rust-works/succinctly/discussions]https://github.com/rust-works/succinctly/discussions

---

**Version**: 1.0
**Last Updated**: January 9, 2026
**Next Review**: July 9, 2026