Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (46 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

69 lines (46 loc) · 1.44 KB

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?

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