Contributing to BitSage Network

Thank you for your interest in contributing to BitSage Network! We're building the future of verifiable compute, and we'd love your help.

---

🌟 Ways to Contribute

💻 Code Contributions

• Bug fixes
• New features
• Performance improvements
• Documentation updates
• Test coverage

📝 Documentation

• Tutorial creation
• API documentation
• Architecture guides
• Use case examples

🐛 Bug Reports

• Detailed issue reports
• Reproducible test cases
• Security vulnerabilities (see Security Policy)

💡 Feature Requests

• New job types
• UI/UX improvements
• Performance optimizations
• Integration suggestions

---

🚀 Getting Started

1. Fork and Clone

# Fork the repo on GitHub, then:
git clone https://github.com/YOUR_USERNAME/REPO_NAME.git
cd REPO_NAME
git remote add upstream https://github.com/Bitsage-Network/REPO_NAME.git

2. Create a Branch

git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-bug-fix

3. Make Your Changes

• Follow our coding standards (see below)
• Write tests for new features
• Update documentation as needed
• Keep commits atomic and well-described

4. Test Your Changes

# Rust
cargo test
cargo clippy
cargo fmt --check

# Cairo
scarb test

# Frontend
npm test
npm run lint

5. Submit a Pull Request

• Push your branch to your fork
• Open a PR against main
• Fill out the PR template
• Request review from maintainers

---

📋 Coding Standards

Rust

• Follow Rust API Guidelines
• Use cargo fmt for formatting
• Pass cargo clippy with no warnings
• Document public APIs with /// comments
• Write unit tests for new functionality

Cairo

• Follow Starknet Cairo Style Guide
• Use clear, descriptive function names
• Document complex logic
• Write unit tests

TypeScript/React

• Follow Airbnb React Style Guide
• Use functional components with hooks
• Prefer TypeScript strict mode
• Write meaningful component tests

---

🔍 Code Review Process

1. Automated Checks: CI/CD must pass (tests, linting, build)
2. Peer Review: At least one maintainer approval required
3. Security Review: For security-sensitive changes
4. Documentation Review: Ensure docs are updated
5. Merge: Squash and merge to main

---

🐛 Reporting Bugs

Security Vulnerabilities

DO NOT open a public issue. Email: security@bitsage.network

Non-Security Bugs

Open an issue with:

• Clear title
• Steps to reproduce
• Expected vs actual behavior
• Environment details (OS, versions, etc.)
• Relevant logs/screenshots

---

💬 Communication

• Discord: discord.gg/QAXDpa7F5K - Real-time chat
• GitHub Issues: For bugs and feature requests
• GitHub Discussions: For questions and ideas
• Twitter/X: @bitsagenetwork - Announcements

---

🎯 Good First Issues

Look for issues labeled good first issue:

• rust-node
• Cairo Contracts
• WebApp

---

🏆 Recognition

Contributors will be:

• Listed in our Contributors Hall of Fame
• Eligible for bounties and rewards (coming soon)
• Invited to community events and AMAs
• Considered for core team positions

---

📜 Code of Conduct

We are committed to providing a welcoming and inclusive environment. Please:

• Be respectful and professional
• Assume good intentions
• Give constructive feedback
• Focus on what's best for the community

Violations can be reported to: conduct@bitsage.network

---

📄 License

By contributing, you agree that your contributions will be licensed under the MIT License.

---

❓ Questions?

Join our Discord or open a GitHub Discussion.

---

Thank you for contributing to BitSage Network! 🚀🔒