Help shape the localLOOP platform.
Contributions are welcome across specs, schemas, docs, and tooling. This project is early-stage, so feedback is especially valuable.
Community standards
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
- Open a discussion first
- Draft an RFC using the template
- Submit PR with RFC document
- Community review period (2 weeks)
- Implementation after approval
For Documentation
- Fork the repository
- Make changes in a feature branch
- Submit a pull request
- 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
- Update CHANGELOG.md
- Update relevant schemas/examples
- Ensure all tests pass
- Request review from maintainers
📜 RFC Process
See rfcs/0000-template.md for the RFC template.
❓ Questions?
- GitHub Discussions or email: alphin@mycel-ai.de
Thank you for helping build the future of circular economy! 🌍
Code of Conduct
Our Pledge
We pledge to make participation in our project a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity, level of experience, nationality, personal appearance, race, religion, or sexual identity.
Our Standards
Positive behavior includes:
- Using welcoming and inclusive language
- Respecting differing viewpoints
- Gracefully accepting constructive criticism
- Focusing on what's best for the community
- Showing empathy towards others
Unacceptable behavior includes:
- Harassment of any kind
- Discriminatory language or actions
- Public or private harassment
- Publishing private information without consent
- Other unprofessional conduct
Enforcement
Project maintainers will remove, edit, or reject contributions that violate this code of conduct. Violations may result in temporary or permanent bans.
Reporting
Report violations to: alphin@mycel-ai.de (GitHub: @alpha912)
Attribution
Based on the Contributor Covenant, version 2.0.