Contributing

We welcome contributions! This guide will help you get started with contributing to MIDIDiff.

Development Setup

Clone the repository:

git clone https://github.com/tayjaybabee/MIDIDiff.git
cd MIDIDiff

Install Poetry if you haven’t already:
```
pip install poetry
```
Install dependencies:
```
poetry install
```
Install development dependencies (including Sphinx for documentation):
```
poetry install --with dev
```

Contribution Guidelines

Code Contributions

Please see CONTRIBUTING.md for detailed guidelines on:

How to contribute code and documentation
Changelog update requirements
Development setup
Pull request process

All contributions with user-facing changes must update the CHANGELOG.md file.

Building Documentation

To build the documentation locally:

cd docs
make html

The generated HTML documentation will be in docs/_build/html/.

To view the documentation, open docs/_build/html/index.html in your browser.

Clean Build

To clean the build directory and rebuild from scratch:

cd docs
make clean
make html

Testing Documentation

To check for broken links and other issues:

cd docs
make linkcheck

Read the Docs

This project is configured for automatic documentation building on Read the Docs. Documentation is built automatically when changes are pushed to the repository.

License

MIDIDiff is licensed under the MIT License. See the LICENSE.md file for details.