Contribute to OSHy-X

We encourage users of OSHy-X to report any bugs, suggest enhancements or create pull requests. Please use this guide to get started.

If you are using Neurodesk to run OSHy-X, you may be interested in its documentation, which has information on usage, troubleshooting and a FAQ.

Before reporting a bug or suggesting an enhancement

Check if your bug or enhancement has already been submitted to OSHy-X Issues page.
Check that you are using the latest version of OSHy-X:
- If you are using Neurodesk, check if you are using the latest version.
- If you are using OSHy-X directly using our Docker container, check that you are pulling the latest version and tag.

To submit a bug report, open an issue here.

Please ensure that you inlucde:

The version and tag number.
The exact steps you took to reproduce the bug, including whether you are using Neurodesk or directly from the Docker container.
Explain in detail the behaviour of the issue you encountered.
If relevant, include the entire error message.
Give an example by linking to your repository, providing code snippets and/or providing screenshots.

To suggest an enhancement, open an issue here.

Please ensure that you include:

The version and tag number of OSHy-X that you are currently using.
A rationale for your suggestion.
A clear description of your suggestion, including the steps taken by the user and the expected behaviour by OSHy-X.
If relevant, provide an example code and/or a screenshot of the enhancement.
Examples of a similar feature in other segmentation pipelines.

Submit a pull request if you wish to contribute directly to OSHy-X.

If you are contributing code, please follow this style guide.

In your pull request:

Provide a detailed description of your change
If your pull request addresses a bug or a suggested enhancement, please provide a link to the issue.
If relevant, provide details on how your change is verified.

Be respectful to all members of the community.
Be constructive with your feedback.
Discrimination, abuse, bullying, initimidation, trolling and unwanted sexual advances will not be tolerated.
Be a decent human being.