First off, thank you for considering contributing to the roex-python package! Your help is appreciated. Following these guidelines helps maintainers and the community understand your suggestions and contributions.
If you find a bug, please ensure the bug was not already reported by searching on GitHub under Issues.
If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
Suggestions for enhancements are tracked as GitHub issues.
Before creating enhancement suggestions, please check the issues list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible, including the steps that you imagine you would take if the feature you're requesting existed.
If you have code changes you'd like to contribute:
- Fork the repository.
- Create a new branch (
git checkout -b feature/your-feature-name). - Make your changes.
- Ensure your code adheres to the project's style guidelines (e.g., using a linter like Flake8 or Black if applicable).
- Add tests for your changes if applicable.
- Commit your changes (
git commit -m 'Add some feature'). - Push to the branch (
git push origin feature/your-feature-name). - Open a Pull Request with a clear title and description of your changes.
Try to follow standard Python conventions (PEP 8) and maintain consistency with the existing codebase style.
If you have questions about contributing, feel free to open an issue and tag it as a 'question'.