Skip to content

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

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Commit your changes (git commit -m 'Write something here')
  5. Push to the branch (git push origin feature/amazing-feature)
  6. Open a Pull Request

Pull Request Guidelines

When submitting a pull request:

  1. Update the README.md with details of changes if applicable
  2. Update the documentation if you're changing functionality
  3. Make sure your code follows the existing code style
  4. Add tests if you're adding new functionality
  5. 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

Released under the MIT License.