Contributing to MarkItDown

MarkItDown is an open-source project that welcomes contributions from the community. This guide will help you get started with contributing to the project.

Setting Up Development Environment

1. Install development dependencies:

pip install hatch
hatch shell

2. Run tests:

hatch test

3. Use the Devcontainer (Alternative):

# Reopen the project in Devcontainer and run:
hatch test

Code Quality

Before submitting a PR:

1. Run pre-commit checks:

pre-commit run --all-files

2. Ensure tests pass:

hatch test

Contributor License Agreement

Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. Visit https://cla.opensource.microsoft.com for details.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Best Practices

1. Create descriptive commit messages
2. Write tests for new features
3. Update documentation as needed
4. Follow the existing code style
5. Keep pull requests focused and single-purpose

For more detailed information about contributing, please refer to our GitHub repository.