contributing

Contributing

Relevant source files

• CONTRIBUTING.md

Prerequisites

Contributors need Python 3.10 or newer, Git, and uv. Live generation requires at least one supported agent CLI (OMP, Claude Code, or Codex). Graphify is only needed when running the default repodocs all pipeline without --no-graph. RepoDocs itself has no runtime dependencies beyond the Python standard library.

Sources: CONTRIBUTING.md:L5-L12

Setup

git clone https://github.com/aryrabelo/repodocs.git
cd repodocs
uv run --extra test pytest

uvx --from . builds the package from the local checkout and runs it without installing anything persistent, and it does not copy credentials.

Sources: CONTRIBUTING.md:L14-L22

Development workflow

Step	Action
1	Create a branch from main
2	Make the smallest change that solves one problem
3	Run the gates: uv run --extra test pytest, uvx ruff@0.15.22 check ., and python3 scripts/check_module_size.py
4	For backend changes, exercise the affected CLI against a small local repository
5	Update README.md and CHANGELOG.md when user-visible behavior changes
6	Open a pull request using the repository template

Sources: CONTRIBUTING.md:L24-L31

Scope

Good contributions improve repository scanning, page planning, cited wiki generation, translation, publishing safety, or compatibility with supported agent CLIs. RepoDocs is intentionally a zero-runtime-dependency, standard-library tool organized as a small src/repodocs package; new runtime dependencies should be discussed before implementation.

Sources: CONTRIBUTING.md:L33-L35

Code of Conduct

Contributors are expected to be respectful, constructive, and specific. Harassment, discrimination, and abusive behavior are not accepted, and maintainers may edit or remove contributions or participation that violate these expectations. Conduct concerns should be reported privately to aryrabelo@gmail.com.

Sources: CONTRIBUTING.md:L37-L41