Skip to content
Closed
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
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -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
36 changes: 36 additions & 0 deletions modules/reminders/AGENTS.md
Original file line number Diff line number Diff line change
@@ -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

<One sentence. The same as the one in the MANIFEST.>

## What this module does not do

<The likely confusions, and which module to point at instead.>

## Internal conventions nobody could guess

<Naming, layout, choices that would surprise an outsider.>

## Business invariants

<What must stay true in every circumstance. Ideally each one has a test.>

## Known traps

<What has already broken here. Every entry should become a test - see
docs/os/10-measurement.md §4.>

## Areas not to change without approval

<What, and why.>

## Non-standard commands

<Only what departs from the MANIFEST verbs.>
84 changes: 84 additions & 0 deletions modules/reminders/MANIFEST.yaml
Original file line number Diff line number Diff line change
@@ -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 <verb> <module>` 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
27 changes: 27 additions & 0 deletions modules/reminders/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# reminders

<One sentence: what this module is for.>

- **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/`.
Empty file.
Empty file.
Empty file.
Loading