Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Contributing to MNUtils

Welcome! Rather than one long checklist that applies unevenly, the rules here are organised by the kind of change you are making. Find your row and follow the page it points to:

You are adding…Start here
A docs page — tutorial or guideWrite a docs page
The record of a significant decisionWrite a dev-diary entry

Each of those pages carries a live checklist, rendered straight from the Claude Code skill that automates that kind of change — so whether you work by hand or with Claude, you follow the same, always-current rules.

Before your first change

  1. Set up your environment — clone the repo, run uv sync --all-extras --dev, and confirm uv run pytest is green.

  2. Make your change. A significant decision starts as a dev-diary draft that gets reviewed before the code is written.

  3. Open a merge/pull request. MNUtils has no enforced branch-protection rules yet — don’t assume required CI checks exist until they actually do (see CLAUDE.md § Commits).

  4. Drive it green, then hand off for review.