Contributing to MTHDS
Thank you for your interest in contributing to the MTHDS specification site. Whether you're clarifying a concept, proposing new content, or fixing an error, your input helps make the standard more accessible to everyone.
Everyone interacting in our community spaces is expected to follow the Code of Conduct. Please review it before getting started.
How to contribute
There are several ways to help improve this site:
- Content: New pages, tutorials, examples, and guides that help explain or illustrate the standard
- Fixes: Typos, broken links, unclear explanations
- Structure: Navigation improvements, better organization
- Style: CSS tweaks, theme customization
Requirements
- Python >= 3.10
- uv >= 0.7.2
Local setup
- Fork & clone the repository
- Run
make installto set up the virtualenv and install dependencies - Run
make docsto serve the site locally athttp://127.0.0.1:8000 - Edit files in the
docs/directory — changes will auto-reload in your browser
Contribution process
- Fork the repository
- Clone it locally
- Install dependencies:
make install - Serve the site locally:
make docs - Create a branch with the format
username/category/short-descriptionwhere category is one of:content,fix,structure, orstyle - Make and commit your changes
- Push your local branch to your fork
- Open a PR with a clear title and description
- Respond to feedback if required