How to contribute to ODTlearn

Welcome! This document covers different ways you can contribute to ODTlearn.

Code of Conduct

This project and everyone participating in it is governed by the ODTlearn code of conduct. By participating, you are expected to uphold this code.

Improve the documentation

The docs are written in Markdown and are built using Sphinx. You can find the source for the docs here.

If your change is small (like fixing typos, or one or two sentence corrections), the easiest way to do this is via GitHub’s online editor. (GitHub has help on how to do this.)

If your change is larger, or touches multiple files, you will need to make the change locally and then use Git to submit a pull request.

File a bug report

Another way to contribute to ODTlearn is to file bug reports.

Please make sure to read the info in the boxes where you write the body of the issue before posting. We also recommend reading this StackOverflow help page on reproducible examples to help ensure that your issue is resolved in a timely manner.