Skip to content

Contributor guide

This page is the hosted contributor entry point for TopMark.

The canonical contributor guide lives at the repository root:

Use this page when browsing the hosted documentation site. Use the root CONTRIBUTING.md file when working directly from a local checkout or GitHub.

Start here

Goal Recommended page
Set up a local development environment Installation guide
Understand contribution workflow and validation commands CONTRIBUTING.md
Understand project architecture Architecture
Understand documentation conventions Documentation conventions
Understand CI and validation workflows CI documentation
Understand releases and publication Release process
Review public API stability Public API
Review internal API reference Internal API reference

Repository map

Important repository entry points:

  • README.md - project overview and GitHub/PyPI landing page
  • INSTALL.md - canonical installation and contributor setup guide
  • CONTRIBUTING.md - canonical contributor guide
  • CHANGELOG.md - release history and compatibility notes
  • docs/ - MkDocs documentation source
  • src/topmark/ - TopMark package source code
  • tests/ - test suite
  • Makefile - local development and validation commands
  • noxfile.py - isolated validation sessions
  • .pre-commit-config.yaml - repository-local pre-commit hooks
  • .pre-commit-hooks.yaml - hooks exported to consumer repositories

Contribution focus areas

Contributor-facing documentation is split by topic:

  • Development documentation covers architecture, public API policy, documentation conventions, release process, and roadmap material.
  • CI documentation covers how this repository validates itself and publishes artifacts.
  • Usage documentation covers the user-facing CLI, configuration, policies, integrations, and workflows.
  • Configuration documentation covers configuration discovery, generated defaults, and schema-oriented reference material.

Further reading