We love your input! We want to make contributing to ClawReinforcementLearning as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
- Fork the repo and create your branch from
main - If you've added code that should be tested, add tests
- Ensure the test suite passes
- Make sure your code lints
- Issue a pull request!
- Update the README.md with details of changes to the interface if applicable
- Update the SKILL.md with any new features or changes
- Increase the version number following Semantic Versioning
- Ensure all tests pass:
python tests/test_env.py - Code should follow PEP 8 style guidelines
- Follow PEP 8 guidelines
- Use type hints where possible
- Add docstrings to functions and classes
- Keep functions under 50 lines when possible
- Use meaningful variable names
Before submitting a PR, run the tests:
python tests/test_env.py- Use a clear and descriptive title
- Describe the exact steps which reproduce the problem
- Provide specific examples to demonstrate the steps
- Describe the behavior you observed after following the steps
- Explain which behavior you expected to see instead and why
- Include screenshots if possible
- Use a clear and descriptive title
- Provide a step-by-step description of the suggested feature
- Provide specific examples to demonstrate the steps
- Describe the current behavior and the expected behavior
- Explain why this feature would be useful
- Join our Discord to discuss features
- Check out the Documentation
- Follow our Blog for updates
By contributing to ClawReinforcementLearning, you agree that your contributions will be licensed under its MIT License.
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Email: community@openkrab.io
Thank you for contributing! 馃