CONTRIBUTING.md

Contributing guidelines

Setup your environment

1. Install uv.

2. Fork this repository.

3. Clone your fork on your machine:

   git clone https://github.com/<your-github-username>/mdws.git

4. Get into the newly created directory:

   cd mdws

5. Install dependencies:

   uv sync --dev

6. Install pre-commit hooks:

   uv run prek install

7. Create a new branch:

   git switch -c <your-branch-name>

8. Make changes and commit:

   git add
   git commit -m "<your-commit-message>"
   git push origin "<your-branch-name>"

9. Create a pull request.

   Click compare across forks if you don't see your branch.

Use Conventional commits

For commit messages, please use Conventional Commits.

See:

• Conventional Commits: reference guide
• Cheatsheet of Sample Conventional Commit Verbs
• Conventional Commit (FR)

Examples of valid commit messages:

• feat: Valide metadata with model
• fix(http): Resolve multiple errors on HTTP queries
• fix: Verify directory exists before writing in (#45)
• docs: Update installation instructions
• style: Format code according with ruff
• refactor: Move CLI argument management into separate module
• test: Add unit tests for the new scraper
• chore: Update dependencies to latest versions