Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 20 additions & 16 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,19 +108,23 @@ local deviation from `planning-convention` 2.2.0.

## Vocabulary

A term is listed only when there is a synonym to reject, or a meaning subtle enough that code and
docs must agree on it.

- **Container** — owns the registries and resolves within a scope. *Avoid:* injector.
- **Provider** — a declaration of *how to produce* a dependency; the recipe, not the value. *Avoid:* service,
dependency.
- **Scope** — one band in the container hierarchy. *Avoid:* lifetime, layer.
- **Group** — a non-instantiable namespace class declaring providers. *Avoid:* module.
- **Resolution** — producing a value from its provider. *Avoid:* injection (reserve that for passing a resolved
value into a handler).
- **Override** — a test-time replacement of a resolved value. *Avoid:* mock, patch (an override supplies a
concrete value; it does not wrap or spy).
- **Bound type** — the type a provider is registered under. *Avoid:* registered type, return type.
- **Wiring plan** — the partition of a creator's parameters by how each is satisfied. *Avoid:* compiled kwargs.
- **Finalizer** — a cleanup callback on a cached provider, run LIFO at close. *Avoid:* teardown, destructor.
- **Connection** — the framework object a unit of work carries. *Avoid:* request (too HTTP-specific).
The domain glossary lives in [`CONTEXT.md`](CONTEXT.md) at the repo root: every term, the synonyms it
rejects, and the rule deciding what is admitted. Read it before naming a concept in code, a test
name, or an issue title.

## Agent skills

### Issue tracker

GitHub Issues on `modern-python/modern-di`, driven through the `gh` CLI; rejected enhancements are
recorded in `docs/adr/`. See [`docs/agents/issue-tracker.md`](docs/agents/issue-tracker.md).

### Triage labels

The five canonical triage roles, each label string equal to its role name. See
[`docs/agents/triage-labels.md`](docs/agents/triage-labels.md).

### Domain docs

Single-context: one root `CONTEXT.md` plus `docs/adr/`. See
[`docs/agents/domain.md`](docs/agents/domain.md).
52 changes: 52 additions & 0 deletions CONTEXT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# modern-di

A zero-dependency Python dependency-injection framework: it wires object graphs
from type annotations, manages lifetimes through a hierarchy of scopes, and runs
sync or async finalizers at close.

## Language

A term is listed only when there is a synonym to reject, or a meaning subtle enough that code and
docs must agree on it. General programming vocabulary does not belong here, however heavily this
project uses it.

**Container**:
Owns the registries and resolves within a scope.
_Avoid_: injector

**Provider**:
A declaration of *how to produce* a dependency; the recipe, not the value.
_Avoid_: service, dependency

**Scope**:
One band in the container hierarchy.
_Avoid_: lifetime, layer

**Group**:
A non-instantiable namespace class declaring providers.
_Avoid_: module

**Resolution**:
Producing a value from its provider.
_Avoid_: injection (reserve that for passing a resolved value into a handler)

**Override**:
A test-time replacement of a resolved value. An override supplies a concrete value; it does not
wrap or spy.
_Avoid_: mock, patch

**Bound type**:
The type a provider is registered under.
_Avoid_: registered type, return type

**Wiring plan**:
The partition of a creator's parameters by how each is satisfied.
_Avoid_: compiled kwargs

**Finalizer**:
A cleanup callback on a cached provider, run LIFO at close.
_Avoid_: teardown, destructor

**Connection**:
The framework object a unit of work carries.
_Avoid_: request (too HTTP-specific)
55 changes: 55 additions & 0 deletions docs/agents/domain.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Domain Docs

How the engineering skills should consume this repo's domain documentation when exploring the
codebase. This repo is **single-context**.

## Before exploring, read these

- **`CONTEXT.md`** at the repo root: the domain glossary.
- **`docs/adr/`**: read the decision records that touch the area you're about to work in.

If any of these files don't exist, **proceed silently**. Don't flag their absence; don't suggest
creating them upfront. The `/domain-modeling` skill creates them lazily when terms or decisions
actually get resolved.

## File structure

```
/
├── CONTEXT.md
├── docs/adr/
│ ├── 0001-….md
│ └── 0002-….md
├── modern_di/
└── tests/
```

There is no `CONTEXT-MAP.md` and no per-package `CONTEXT.md`: one package, one context.

## Use the glossary's vocabulary

When your output names a domain concept (in an issue title, a refactor proposal, a hypothesis, a test
name), use the term as defined in `CONTEXT.md`. Don't drift to synonyms the glossary explicitly
avoids: write `Container` and not `injector`, `Provider` and not `service`, `Resolution` and not
`injection`.

If the concept you need isn't in the glossary yet, that's a signal: either you're inventing language
the project doesn't use (reconsider) or there's a real gap (note it for `/domain-modeling`).

## Link style inside `docs/`

`docs/` is the MkDocs `docs_dir`, and the same files are read on GitHub. Two rules keep a link
working in both renderings:

- **Between files inside `docs/`, use a plain relative `.md` link.** MkDocs rewrites it to a site
URL and GitHub follows it as a file. From one ADR to another, that is `[ADR-NNNN](NNNN-slug.md)`.
- **Never link from a file inside `docs/` to a path outside it.** It cannot resolve in both
renderings: MkDocs emits `links.not_found` and ships the link verbatim, so it 404s on the site.
Cite `modern_di/...`, `tests/...`, and root files as inline code, never as links.

## Flag ADR conflicts

If your output contradicts an existing decision record, surface it explicitly rather than silently
overriding:

> _Contradicts ADR-NNNN (its title), but worth reopening because…_
55 changes: 55 additions & 0 deletions docs/agents/issue-tracker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Issue tracker: GitHub

Issues and specs for this repo live as GitHub issues on `modern-python/modern-di`. Use the `gh` CLI
for all operations.

## Conventions

- **Create an issue**: `gh issue create --title "..." --body "..."`. Use a heredoc for multi-line bodies.
- **Read an issue**: `gh issue view <number> --comments`, filtering comments by `jq` and also fetching labels.
- **List issues**: `gh issue list --state open --json number,title,body,labels,comments --jq '[.[] | {number, title, body, labels: [.labels[].name], comments: [.comments[].body]}]'` with appropriate `--label` and `--state` filters.
- **Comment on an issue**: `gh issue comment <number> --body "..."`
- **Apply / remove labels**: `gh issue edit <number> --add-label "..."` / `--remove-label "..."`
- **Close**: `gh issue close <number> --comment "..."`

Infer the repo from `git remote -v`; `gh` does this automatically when run inside a clone.

## Pull requests as a triage surface

**PRs as a request surface: no.** _(Set to `yes` if this repo treats external PRs as feature requests; `/triage` reads this flag.)_

When set to `yes`, PRs run through the same labels and states as issues, using the `gh pr` equivalents:

- **Read a PR**: `gh pr view <number> --comments` and `gh pr diff <number>` for the diff.
- **List external PRs for triage**: `gh pr list --state open --json number,title,body,labels,author,authorAssociation,comments` then keep only `authorAssociation` of `CONTRIBUTOR`, `FIRST_TIME_CONTRIBUTOR`, or `NONE` (drop `OWNER`/`MEMBER`/`COLLABORATOR`).
- **Comment / label / close**: `gh pr comment`, `gh pr edit --add-label`/`--remove-label`, `gh pr close`.

GitHub shares one number space across issues and PRs, so a bare `#42` may be either: resolve with `gh pr view 42` and fall back to `gh issue view 42`.

## When a skill says "publish to the issue tracker"

Create a GitHub issue.

## When a skill says "fetch the relevant ticket"

Run `gh issue view <number> --comments`.

## Rejected work: read and write `docs/adr/`, not `.out-of-scope/`

Where a skill says `.out-of-scope/`, this repo means `docs/adr/`. A rejected enhancement is recorded
there as a decision record, and the prior-rejection check during triage reads that directory. Do not
create `.out-of-scope/`: this repo keeps one home for a rejected alternative, and a second one would
split the corpus that the check depends on.

## Wayfinding operations

Used by `/wayfinder`. The **map** is a single issue with **child** issues as tickets.

- **Map**: a single issue labelled `wayfinder:map`, holding the Notes / Decisions-so-far / Fog body. `gh issue create --label wayfinder:map`.
- **Child ticket**: an issue linked to the map as a GitHub sub-issue (`gh api` on the sub-issues endpoint). Where sub-issues aren't enabled, add the child to a task list in the map body and put `Part of #<map>` at the top of the child body. Labels: `wayfinder:<type>` (`research`/`prototype`/`grilling`/`task`). Once claimed, the ticket is assigned to the driving dev.
- **Blocking**: GitHub's **native issue dependencies**, the canonical, UI-visible representation. Add an edge with `gh api --method POST repos/<owner>/<repo>/issues/<child>/dependencies/blocked_by -F issue_id=<blocker-db-id>`, where `<blocker-db-id>` is the blocker's numeric **database id** (`gh api repos/<owner>/<repo>/issues/<n> --jq .id`, _not_ the `#number` or `node_id`). GitHub reports `issue_dependencies_summary.blocked_by` (open blockers only, the live gate). Where dependencies aren't available, fall back to a `Blocked by: #<n>, #<n>` line at the top of the child body. A ticket is unblocked when every blocker is closed.
- **Frontier query**: list the map's open children (`gh issue list --state open`, scoped to the map's sub-issues / task list), drop any with an open blocker (`issue_dependencies_summary.blocked_by > 0`, or an open issue in the `Blocked by` line) or an assignee; first in map order wins.
- **Claim**: `gh issue edit <n> --add-assignee @me`, the session's first write.
- **Resolve**: `gh issue comment <n> --body "<answer>"`, then `gh issue close <n>`, then append a context pointer (gist + link) to the map's Decisions-so-far.

The `wayfinder:*` labels do not exist in this repo yet. Create them the first time `/wayfinder` runs.
20 changes: 20 additions & 0 deletions docs/agents/triage-labels.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Triage Labels

The skills speak in terms of five canonical triage roles. This file maps those roles to the actual
label strings used in this repo's issue tracker. All five exist on `modern-python/modern-di`.

| Canonical role | Label in our tracker | Meaning |
| ----------------- | -------------------- | ---------------------------------------- |
| `needs-triage` | `needs-triage` | Maintainer needs to evaluate this issue |
| `needs-info` | `needs-info` | Waiting on reporter for more information |
| `ready-for-agent` | `ready-for-agent` | Fully specified, ready for an AFK agent |
| `ready-for-human` | `ready-for-human` | Requires human implementation |
| `wontfix` | `wontfix` | Will not be actioned |

When a skill mentions a role (e.g. "apply the AFK-ready triage label"), use the corresponding label
string from this table.

Edit the right-hand column to match whatever vocabulary you actually use.

The repo's `bug`, `enhancement`, and `documentation` labels are a separate *kind* vocabulary. They do
not overlap these *state* labels, and triage leaves them alone unless it is setting the category role.
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,10 @@ theme:
icon: material/brightness-4
name: Switch to system preference

# docs/agents/ is agent configuration, not user documentation.
exclude_docs: |
/agents/

validation:
omitted_files: warn
absolute_links: warn
Expand Down
Loading