Contributing to LOOP

Thank you for your interest in contributing to LOOP! We're building this together as a community.

🤝 Code of Conduct

Please read our Code of Conduct before contributing.

🐛 Reporting Issues

• Check existing issues first
• Use issue templates
• Provide clear reproduction steps
• Include relevant logs/screenshots

💡 Proposing Changes

For Specification Changes

1. Open a discussion first
2. Draft an RFC using the template
3. Submit PR with RFC document
4. Community review period (2 weeks)
5. Implementation after approval

For Documentation

1. Fork the repository
2. Make changes in a feature branch
3. Submit a pull request
4. Respond to review feedback

🔧 Development Setup

# Clone the repository
git clone https://github.com/local-loop-io/loop-protocol.git
cd loop-protocol

# Install dependencies (for schema validation)
npm install

# Run tests
npm test

📝 Style Guidelines

• Use clear, descriptive commit messages
• Follow existing formatting
• Add examples for new features
• Update relevant documentation

🚀 Pull Request Process

1. Update CHANGELOG.md
2. Update relevant schemas/examples
3. Ensure all tests pass
4. Request review from maintainers

📜 RFC Process

See rfcs/0000-template.md for the RFC template.

❓ Questions?

• GitHub Discussions or email: dev@mycel-ai.de

Thank you for helping build the future of circular economy! 🌍

Code of Conduct

Our Pledge

We pledge to make our community welcoming, safe, and equitable for all.

We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.

Encouraged Behaviors

While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.

With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:

1. Respecting the purpose of our community, our activities, and our ways of gathering.
2. Engaging kindly and honestly with others.
3. Respecting different viewpoints and experiences.
4. Taking responsibility for our actions and contributions.
5. Gracefully giving and accepting constructive feedback.
6. Committing to repairing harm when it occurs.
7. Behaving in other ways that promote and sustain the well-being of our community.

Restricted Behaviors

We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.

1. Harassment. Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
2. Character attacks. Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
3. Stereotyping or discrimination. Characterizing anyone's personality or behavior on the basis of immutable identities or traits.
4. Sexualization. Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
5. Violating confidentiality. Sharing or acting on someone's personal or private information without their permission.
6. Endangerment. Causing, encouraging, or threatening violence or other harm toward any person or group.
7. Behaving in other ways that threaten the well-being of our community.

Other Restrictions

1. Misleading identity. Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
2. Failing to credit sources. Not properly crediting the sources of content you contribute.
3. Promotional materials. Sharing marketing or other commercial content in a way that is outside the norms of the community.
4. Irresponsible communication. Failing to responsibly present content which includes, links to, or describes any other restricted behaviors.

Reporting an Issue

Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.

When an incident does occur, it is important to report it promptly. To report a possible violation, email dev@mycel-ai.de or open a GitHub Discussion in the relevant repository.

Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.

Addressing and Repairing Harm

If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.

1. Warning — A private, written warning from the Community Moderators. Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
2. Temporarily Limited Activities — A private, written warning with a time-limited cooldown period. The cooldown period may be limited to particular channels or interactions. Examples of repair include making an apology and being thoughtful about re-entering community spaces after the period is over.
3. Temporary Suspension — A private written warning with conditions for return. Examples of repair include respecting the spirit of the suspension and meeting the specified conditions for return.
4. Permanent Ban — Access to all community spaces, tools, and communication channels is removed. Reserved for patterns of repeated violations or a single violation so serious that the Community Moderators determine there is no way to keep the community safe.

This enforcement ladder is intended as a guideline and does not limit the ability of Community Moderators to use their discretion in keeping with the best interests of the community.

Scope

This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other 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.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 3.0, licensed under CC BY-SA 4.0 by the Organization for Ethical Source.

For answers to common questions about Contributor Covenant, see the FAQ. Translations are available at https://www.contributor-covenant.org/translations.