Skip to content

contributing.md

Latest commit

 

History

History
74 lines (56 loc) · 3.16 KB

contributing.md

File metadata and controls

74 lines (56 loc) · 3.16 KB
Raw

Contributing

Repository-specific rules for the contrib monorepo. Shared engineering standards are owned by softwareone-platform/mpt-extension-skills — commit messages, pull requests, Python coding, unit tests, packaging, and documentation conventions live there; the rules below are the repo-local additions.

Repository rules

  • Keep each top-level module independently releasable; do not create a root public distribution.
  • Never add mpt_extension_contrib/__init__.py (see architecture.md).
  • Put shared tooling config and shared dev tools in the root pyproject.toml; put a module's runtime and dev dependencies in that module's pyproject.toml.
  • There is one shared uv.lock; regenerate and commit it after any dependency change.
  • Update the matching document when behaviour or workflow changes.

Adding a module

make create-module module=<kebab-case-name>

This renders the module from scripts/templates/module/ (via copier), copies the root LICENSE, and auto-wires the module into the workspace — the root pyproject.toml (members, pytest testpaths, mypy mypy_path), make/common.mk PACKAGES, and the package tables in the root README.md and AGENTS.md — then refreshes uv.lock. New modules need no edit to the CI or release workflows; both derive what they need from the workspace members.

The generated implementation, tests, and module docs are placeholders — replace them with the real API before the module's first release. Then validate:

make check-all pkg=<module>

Keep scaffold content in scripts/templates/module/ and the repository wiring in scripts/scaffold_module.py.

Validation

Follow the shared build-and-checks workflow. The repo command mapping — what make check/make test run, all inside the shared dev image so local results match CI — is in testing.md. PR CI builds/tests only the modules a change touched.

Dependencies

Dependabot tracks the root uv workspace, docker, and github-actions (dependabot.yml). Because the workspace has one shared uv.lock, dependency bumps stay coordinated in a single pull request even though modules release independently.

External service setup

Some integrations are configured outside the repository:

  • PyPI (per module) — configure trusted publishing for mpt-extension-contrib-<module> before its first release; see releases.md.
  • SonarCloud (once for the repository) — the whole workspace is one SonarCloud project (softwareone-platform_mpt-extension-python-contrib), so it works on the free plan. Add a single repository secret SONAR_TOKEN; the PR workflow's sonar job skips the scan until it exists. See testing.md for how the scan and coverage are wired.

Releases

See releases.md for tags, versioning, and the manual release workflow.