Thank you for considering contributing to our project! Here are some guidelines to help you get started.
Bugs
- Open an issue.
- Provide as much context as you can about what you're running into.
- Provide project and platform versions.
- Before reporting an issue, check if it has already been reported.
- Include detailed information about the issue, including steps to reproduce, environment details, and screenshots if applicable.
The recommended method of contributing is as follows:
- Create an issue on the issues page
- Fork the repository to your own account
- Fix issue and push changes to your own fork on GitHub
- Create a pull request from your fork (whatever branch you worked on) to the development branch in the main repository.
The links to the example data are in the: rt-utils/tests/mock_data/ rt-utils/tests/one_slice_data/ rt-utils/tests/oriented_data/
- Fork the repository and create a new branch for your feature or bug fix.
- Make sure your code follows the project’s coding style and passes all tests.
- Submit a pull request with a clear description of your changes and the problem they solve.
- Please be respectful and considerate in all interactions.
- If you have questions or need help, reach out to [email protected].
RT-utils is subject to the MIT License
, which can be found in the project's root.