​

Contributing

​

Ways to Contribute

• Report bugs - File issues on GitHub
• Suggest features - Start a discussion
• Fix bugs - Submit pull requests
• Add features - Implement roadmap items
• Improve docs - Fix typos, add examples
• Help others - Answer questions

​

Getting Started

​

1. Fork the Repository

git clone https://github.com/YOUR_USERNAME/brainzlab.git
cd brainzlab

​

2. Set Up Development Environment

# Install dependencies
bundle install

# Set up database
rails db:setup

# Start the server
rails server

​

3. Create a Branch

git checkout -b feature/my-feature

​

4. Make Your Changes

• Write tests
• Follow code style
• Update documentation

​

5. Submit a Pull Request

• Describe your changes
• Link related issues
• Request review

​

Code Style

​

Ruby

• Follow Ruby Style Guide
• Use RuboCop: bundle exec rubocop

​

JavaScript

• Follow Airbnb Style Guide
• Use ESLint: npm run lint

​

Testing

# Ruby tests
bundle exec rspec

# JavaScript tests
npm test

​

Documentation

• Use MDX format
• Include code examples
• Add to navigation in mint.json

​

Code of Conduct

​

License

​

Questions?

• GitHub Discussions
• Discord