Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (27 loc) · 830 Bytes

CONTRIBUTING.md

File metadata and controls

40 lines (27 loc) · 830 Bytes
Raw

Contributing

Development Setup

uv sync --dev

This installs the project and the development toolchain into the local virtual environment managed by uv.

Common Commands

uv run pytest
uv run ruff check
uv run mypy

Run the full test suite before opening a pull request. If you change CLI behavior, also verify:

uv run nomnom --help

Working on Plugins

Use the built-in scaffold to create a local plugin package:

uv run nomnom plugin create my-plugin

Local plugins live under plugins/. The built-in rules plugin is implemented in nomnom.builtin.rules.

Pull Requests

  • Keep changes focused and minimal.
  • Add or update tests for behavior changes.
  • Update docs or examples when public-facing behavior changes.
  • Prefer small commits with clear messages.