Advanced Topics
Contributing
Thank you for your interest in contributing to runnem! We welcome all forms of contributions, from documentation improvements to feature suggestions.
Getting Started
- Fork the repository
- Create a new branch for your changes
- Make your changes
- Submit a pull request
Development Setup
To set up your development environment:
- Clone your fork:
git clone https://github.com/your-username/runnem.git
cd runnem
- Install dependencies:
npm install
- Make your changes and commit them:
git add .
git commit -m "Description of your changes"
Contribution Guidelines
- Follow the existing code style
- Write clear commit messages
- Keep pull requests focused and small
- Update documentation as needed
Areas for Contribution
- Documentation improvements
- Bug reports
- Feature suggestions
- Code improvements
- Community support
Code Review Process
- Submit your pull request
- Wait for review
- Address any feedback
- Once approved, your changes will be merged
Getting Help
- Open an issue for questions
Next Steps
- Review the contribution guidelines
- Start with small, focused changes
- Open an issue for suggestions or bug reports