diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index a0734fd..3d1da49 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -19,3 +19,4 @@ # Modules — one line per module, added by the scaffolding. /modules/catalog/ @NapkinStack/catalog /modules/loans/ @NapkinStack/loans +/modules/reminders/ @NapkinStack/maintainers diff --git a/modules/reminders/AGENTS.md b/modules/reminders/AGENTS.md new file mode 100644 index 0000000..6fa6699 --- /dev/null +++ b/modules/reminders/AGENTS.md @@ -0,0 +1,36 @@ +# reminders — local instructions + +> Only what is **specific to this module**. +> Never duplicate a kernel rule (`/AGENTS.md`): that is wasted context and a source of +> divergence. +> +> Indicative budget: 100 lines. + +## Responsibility + + + +## What this module does not do + + + +## Internal conventions nobody could guess + + + +## Business invariants + + + +## Known traps + + + +## Areas not to change without approval + + + +## Non-standard commands + + diff --git a/modules/reminders/MANIFEST.yaml b/modules/reminders/MANIFEST.yaml new file mode 100644 index 0000000..065a046 --- /dev/null +++ b/modules/reminders/MANIFEST.yaml @@ -0,0 +1,84 @@ +# Machine-readable source of truth for the module. +# Read by: humans (onboarding), agents (scoping), CI (fitness functions). +# Any divergence between this file and the code fails CI. + +module: + name: "reminders" + + # ONE sentence. If it needs an "and", the module probably does two things. + responsibility: > + TODO - describe this module's business capability in one sentence. + + owner: "NapkinStack/maintainers" # a GitHub team, organisation/team; a user only without an organisation + contact: "@NapkinStack/maintainers" + + # proposed | active | maintenance | deprecated | retired (docs/os/02-modules.md §6) + lifecycle: proposed + + # prototype | standard | high | critical (docs/os/07-governance.md §6) + criticality: "standard" + + # Does a user see this module? true requires a test sheet on its pull requests + # (docs/os/05-workflow.md §7). + user_facing: true + + # The module's name in the code, when it differs from the folder (package, namespace). + # Used by boundary detection. + # code_name: reminders + + # Only when lifecycle = deprecated. The check turns red once the date has passed. + # deprecation: + # replaced_by: + # removal_date: YYYY-MM-DD + +# Contracts PROVIDED by this module. `path` holds its document (B7). +provides: [] +# - contract: reminders-api +# version: v1 +# path: contracts/reminders-api/v1 +# stability: experimental # experimental | stable | deprecated +# # removal_date: YYYY-MM-DD # required when stability = deprecated + +# Contracts CONSUMED - this is the DECLARED graph. +# CI compares it with the contracts this module's files read: one read and not declared +# fails (B1), one declared and never read is reported (B4), one nobody provides fails (B6). +consumes: [] +# - contract: identity-api +# version: v1 +# module: identity + +# Data owned. Nobody else accesses it directly. +data: + owns: [] + shared: [] # any exception requires a named ADR + +# Significant external dependencies. +# Each one declares its exit strategy (docs/os/06-decisions.md §3). +dependencies: [] +# - name: +# purpose: +# adr: +# exit_strategy: + +# Standard verbs: the same names everywhere, running this module's stack commands +# (docs/os/09-platform.md §2). `nstack ` runs them from this folder. +# No stack is imposed. check and test are required once the module holds more than its +# description (fitness M7): declare them before its first file of code. +commands: +# check: # under 2 min: format, lint, types +# test: # NEVER starts another module +# bootstrap: # optional: make the module usable from a fresh clone +# run: # optional: local start, with doubles for the dependencies +# e2e: # optional: end-to-end scenarios; evidence written to .evidence/ + +# Review budget. Inherited from the project when absent (docs/os/05-workflow.md §4). +review_budget: + max_lines: 400 + max_files: 15 + max_modules: 1 # not adjustable + +docs: + readme: README.md + agents: AGENTS.md + adr: docs/adr/ + # runbook: docs/runbook.md # required when criticality >= high diff --git a/modules/reminders/README.md b/modules/reminders/README.md new file mode 100644 index 0000000..786a68c --- /dev/null +++ b/modules/reminders/README.md @@ -0,0 +1,27 @@ +# reminders + + + +- **Owner**: NapkinStack/maintainers +- **Criticality**: standard +- **Manifest**: [MANIFEST.yaml](./MANIFEST.yaml) + +## Getting started + +```bash +nstack bootstrap reminders # from a fresh clone, when declared +nstack check reminders # format, lint, types - under 2 min +nstack test reminders # never starts another module +nstack run reminders # locally, with doubles for the dependencies +``` + +Commands: the `commands` section of the MANIFEST, to declare for this module's stack. + +## Contracts + +- Provided: see `provides` in the MANIFEST +- Consumed: see `consumes` in the MANIFEST + +## Decisions + +See `docs/adr/`. diff --git a/modules/reminders/docs/adr/.gitkeep b/modules/reminders/docs/adr/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/modules/reminders/src/.gitkeep b/modules/reminders/src/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/modules/reminders/tests/.gitkeep b/modules/reminders/tests/.gitkeep new file mode 100644 index 0000000..e69de29