Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

38 lines (29 loc) · 1.5 KB

Contributing to RT-utils

Thank you for considering contributing to our project! Here are some guidelines to help you get started.

Bugs

  1. Open an issue.
  2. Provide as much context as you can about what you're running into.
  3. Provide project and platform versions.

How to Report Issues

  • 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:

  1. Create an issue on the issues page
  2. Fork the repository to your own account
  3. Fix issue and push changes to your own fork on GitHub
  4. Create a pull request from your fork (whatever branch you worked on) to the development branch in the main repository.

Sample Data

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/

How to Submit Code

  • 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.

Code of Conduct

  • Please be respectful and considerate in all interactions.

Contact

License

RT-utils is subject to the MIT License, which can be found in the project's root.