Contributing
We welcome contributions to RLLM! This guide will help you get started with contributing to the project.
Ways to Contribute
There are many ways you can contribute to RLLM:
- Report bugs and issues
- Suggest new features
- Improve documentation
- Submit code changes
- Help other users
- Share the project
Development Process
- Fork the repository
- Create a new branch (
git checkout -b feature/amazing-feature
) - Make your changes
- Commit your changes (
git commit -m 'Write something here'
) - Push to the branch (
git push origin feature/amazing-feature
) - Open a Pull Request
Pull Request Guidelines
When submitting a pull request:
- Update the README.md with details of changes if applicable
- Update the documentation if you're changing functionality
- Make sure your code follows the existing code style
- Add tests if you're adding new functionality
- Make sure all tests pass
Code Style
- Follow Swift's official style guide
- Use SwiftUI best practices
- Write meaningful commit messages
- Document your code using comments
- Keep functions small and focused
Getting Help
Need help? Feel free to:
- Open an issue
- Start a discussion
- Join our community