# Contributing Thank you for your interest in contributing to RiOS! This document provides guidelines and instructions for contributing to the project. ## Ways to Contribute ### 1. Code Contributions * Bug fixes * New features * Performance improvements * Test coverage ### 2. Documentation * Improve existing docs * Add tutorials and guides * Translate documentation * Fix typos and errors ### 3. Community Support * Answer questions on the forum * Help other users troubleshoot issues * Share your RiOS use cases * Write blog posts and tutorials ### 4. Testing * Report bugs * Test new features * Participate in beta programs * Provide feedback ### 5. Infrastructure * Run worker nodes * Contribute to network stability * Test in different environments ## Getting Started ### Prerequisites **For Code Contributions**: * Git * Go 1.19+ (for backend work) * Node.js 18+ (for frontend work) * Docker * Familiarity with the codebase **For Documentation**: * Markdown knowledge * GitBook (optional) * Good written English ### Setting Up Development Environment ```bash # Clone the repository git clone https://github.com/rios/rios.git cd rios # Install dependencies npm install # for frontend go mod download # for backend # Run tests npm test # frontend tests go test ./... # backend tests # Start development server npm run dev # frontend go run main.go # backend ``` ## Contribution Workflow ### 1. Find or Create an Issue Before starting work: * Check [existing issues](https://github.com/rios/rios/issues) * Create a new issue if none exists * Discuss your approach in the issue comments * Wait for maintainer approval for large changes ### 2. Fork and Branch ```bash # Fork the repository on GitHub # Clone your fork git clone https://github.com/YOUR_USERNAME/rios.git cd rios # Add upstream remote git remote add upstream https://github.com/rios/rios.git # Create a feature branch git checkout -b feature/your-feature-name ``` ### 3. Make Changes **Code Style**: * Follow existing code style * Use meaningful variable names * Add comments for complex logic * Write tests for new features **Commit Messages**: ``` ():