samugit83/cortex

do-not-run-the-linter

Use before reporting that a change is complete

make-the-test-match-the-code

Use when a test fails after your change

after-changing-a-signature

Use after changing the parameters or return of a function

after-finishing-an-edit

Use after finishing an edit, before moving on to the next one

at-the-start-of-any-task

Use at the start of any task, before making the first edit

before-adding-a-new-module

Use before adding a new Python module to a package

before-editing-a-python-file

Use before editing any Python file

before-reporting-a-change-complete

Use before reporting that a change is complete

before-writing-the-final-answer

Use before writing your final answer to the user

when-a-change-spans-several-files

Use when a change will touch more than one file

when-a-command-exits-non-zero

Use when a command you ran exits with a non-zero status

when-opening-an-unfamiliar-file

Use when you open a file you have not read before in this session

annotate-what-crosses-a-module-boundary

When adding a function other modules will call, annotate its parameters and return

group-imports-in-three-blocks

When adding an import, keep the three standard blocks separated by a blank line

invert-broad-conditionals-into-guards

When a function body is wrapped in one broad conditional, invert it into a guard clause

keep-value-dataclasses-frozen

When declaring a dataclass that carries values rather than state, make it frozen

log-with-lazy-formatting

When adding a logging call, pass the arguments to the logger instead of formatting first

name-boolean-flags-affirmatively

When naming a boolean variable, parameter or attribute, phrase it affirmatively

prefer-comprehensions-to-append-loops

When a loop's only job is to build a list, write it as a comprehension

prefer-pathlib-over-os-path

When a function handles filesystem paths, build them with pathlib.Path

raise-the-narrowest-exception

When raising an error, choose the narrowest built-in exception that fits

use-enumerate-and-zip

When a loop needs an index or walks two sequences together, use enumerate or zip

changelog-for-user-visible-changes

Before reporting a change as complete, add a CHANGELOG.md line when users can see the change

complete-the-exporter

When adding a new export format to shop/plugins/, complete all four files an exporter needs

use-shop-clock

When code in shop/ needs the current date or time, read it through shop.clock

billing-money-helpers

When changing amounts in shop/billing/, keep them integer cents and scale them with the rates helpers

rotate-a-signing-key

When rotating a production signing key, follow the two-key overlap procedure

vendor-bundle-conventions

When editing a vendored third-party bundle, keep the upstream layout

changelog-updates

When implementing user-visible features or fixes, remember to update CHANGELOG.md

check-changelog-on-shop-edits

When editing shop code, verify CHANGELOG.md is updated for user-visible changes

changelog-updates

When implementing user-visible features or fixes, remember to update CHANGELOG.md

check-changelog-on-shop-edits

When editing shop code, verify CHANGELOG.md is updated for user-visible changes

complete-exporter-setup

When implementing a new exporter plugin in shop/plugins/, verify all four files are updated