Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (42 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

55 lines (42 loc) · 1.52 KB

Contributing to Orpheon

Thank you for your interest in contributing to the Orpheon Protocol! We are building the operating system for the next generation of autonomous software, and we need your help.

🤝 Code of Conduct

This project adheres to the Rust Code of Conduct. By participating, you are expected to uphold this code.

🛠️ Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/AaryanBansal-Dev/Orpheon-API.git
cd Orpheon-API
  3. Install Rust: Ensure you have the latest stable Rust toolchain. 
    rustup update stable

🧪 Development Workflow

We use a standard feature-branch workflow.

  1. Create a new branch for your feature or fix: 
    git checkout -b feature/amazing-new-planner
  2. Write Code: Implement your changes.
  3. Run Tests: 
    cargo test
  4. Format Code: 
    cargo fmt
  5. Lint Code: 
    cargo clippy -- -D warnings

📝 Commit Guidelines

We use Conventional Commits:

  • feat: add Zero-Knowledge Proof verifier
  • fix: resolve race condition in state store
  • docs: update CONTEXT.md with new features
  • perf: optimize A* heuristic calculation

⚖️ Legal

By contributing to Orpheon, you agree that your contributions will be licensed under its dual MIT/Apache-2.0 license.