Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Contribution Guide

Welcome to the Ciro Network community! 🌟

Whether you're a developer, researcher, community builder, content creator, or simply someone passionate about decentralized computing, there's a place for you here. This guide will help you find your path to contributing to our mission of making AI computing accessible to everyone.

🤝 Everyone is Welcome

Ciro Network thrives on diverse perspectives and contributions. You don't need to be a blockchain expert or AI researcher to make a meaningful impact. Here are some ways you can contribute:

💻 For Developers

  • Smart Contracts: Help improve our Cairo contracts on Starknet
  • Rust Backend: Contribute to our node implementation and coordinator services
  • Frontend/UI: Build user interfaces for providers and users
  • Testing: Write tests, find bugs, improve reliability
  • Documentation: Help make our docs clearer and more accessible

🔬 For Researchers

  • ZK-ML: Research zero-knowledge machine learning techniques
  • Tokenomics: Analyze and improve our economic models
  • Network Design: Study distributed computing architectures
  • Security: Audit our smart contracts and protocols
  • Performance: Optimize our compute distribution algorithms

🌍 For Community Builders

  • Discussions: Participate in community forums and Discord
  • Events: Help organize meetups, hackathons, or workshops
  • Outreach: Spread the word about decentralized computing
  • Support: Help newcomers understand the project
  • Feedback: Share your ideas and suggestions

📝 For Content Creators

  • Documentation: Write tutorials, guides, and explanations
  • Blog Posts: Share insights about decentralized computing
  • Videos: Create educational content about Ciro Network
  • Graphics: Design diagrams, infographics, and visual content
  • Translations: Help make our content available in more languages

💡 For Everyone

  • Ideas: Share your thoughts on how to improve the network
  • Testing: Try out our tools and provide feedback
  • Bug Reports: Help us identify and fix issues
  • Feature Requests: Suggest new capabilities you'd like to see
  • Questions: Ask questions that help us improve our explanations

🚀 Getting Started

1. Join Our Community

2. Choose Your Path

3. Find Your First Contribution

  • Look for issues labeled good first issue or help wanted
  • Check our Contributing Standards for guidelines
  • Join community discussions to understand current priorities
  • Don't hesitate to ask questions - we're here to help!

🔧 Development Workflow

If you're contributing code, here's our typical workflow:

1. Fork and Clone

# Fork the repository on GitHub
# Then clone your fork locally
git clone https://github.com/your-username/ciro-network.git
cd ciro-network

2. Set Up Your Environment

# Install dependencies
npm install  # For JavaScript/TypeScript projects
cargo build  # For Rust projects
scarb build  # For Cairo contracts

3. Create a Branch

git checkout -b feature/your-feature-name
# or
git checkout -b fix/issue-description

4. Make Your Changes

  • Write clear, well-documented code
  • Add tests for new functionality
  • Update documentation as needed
  • Follow our coding standards

5. Test Your Changes

npm test     # Run JavaScript tests
cargo test   # Run Rust tests
scarb test   # Run Cairo tests

6. Submit a Pull Request

  • Write a clear description of your changes
  • Reference any related issues
  • Include screenshots for UI changes
  • Respond to review feedback promptly

📋 Contribution Guidelines

Code Contributions

  • Follow our coding standards
  • Write clear commit messages
  • Include tests for new features
  • Update documentation when needed
  • Keep PRs focused and manageable

Documentation Contributions

  • Write in clear, accessible language
  • Include examples and code snippets
  • Update links and references
  • Consider translations for global accessibility

Community Contributions

  • Be respectful and inclusive
  • Help newcomers feel welcome
  • Share knowledge and resources
  • Provide constructive feedback

Bug Reports

  • Use our bug report template
  • Include steps to reproduce
  • Provide system information
  • Be patient while we investigate

Feature Requests

  • Check if the feature already exists
  • Explain the problem you're solving
  • Consider the impact on the community
  • Be open to discussion and alternatives

🎯 What We Value

Inclusivity

  • We welcome contributors from all backgrounds
  • We value diverse perspectives and experiences
  • We're committed to making our project accessible to everyone

Transparency

  • We share our roadmap and decision-making process
  • We're open about challenges and trade-offs
  • We encourage questions and discussions

Quality

  • We strive for excellence in everything we do
  • We value thorough testing and documentation
  • We prioritize user experience and security

Community

  • We believe in the power of collaboration
  • We support each other's growth and learning
  • We celebrate contributions of all sizes

🆘 Need Help?

Don't hesitate to reach out! We're here to help you succeed:

  • General Questions: Join our Discord or GitHub Discussions
  • Technical Issues: Check our documentation or create an issue
  • Security Concerns: Email us at security@ciro.network
  • Partnership Inquiries: Contact us at partnerships@ciro.network

🎉 Recognition

We believe in recognizing and celebrating contributions:

  • Contributor Hall of Fame: We maintain a list of significant contributors
  • Community Spotlight: We highlight outstanding community members
  • Swag and Rewards: Contributors may receive Ciro Network merchandise
  • Token Rewards: Active contributors may receive CIRO tokens

📚 Next Steps

Ready to dive deeper? Check out these resources:

Thank you for being part of our journey! 🌟

Every contribution, no matter how small, helps us build a more accessible and decentralized future for AI computing. Together, we're making the impossible possible.

Questions? Ideas? Just want to say hello? We'd love to hear from you!