@activatus/code-standards 3.0.7 → 3.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/docs/Guides/setup.md
CHANGED
|
@@ -9,7 +9,7 @@ sidebar_label: "Setup"
|
|
|
9
9
|
|
|
10
10
|
The person creates the app themselves — with `create-next-app`, Expo or anything else — and tells you to follow the standards. **Do not ask which framework the project uses.** Look at the project: its `package.json` and files tell you. The person only answers the questions below and checks your work. They never run a command.
|
|
11
11
|
|
|
12
|
-
**These standards are the base for code, plus
|
|
12
|
+
**These standards are the base for code, plus how agents link and report the project's work.** A project builds on top of them: it can add its own folders and conventions, and it makes its own project-management decisions (tickets, releases, branches, commit messages, who commits). Those go in the project's own docs, not here. Step 3 records the project's GitHub repo and Linear project, and offers the optional [status circles](/docs/Standards/working-with-agents#status-circles).
|
|
13
13
|
|
|
14
14
|
## 1. Install the standards
|
|
15
15
|
|
|
@@ -24,6 +24,14 @@ minimumReleaseAgeExclude:
|
|
|
24
24
|
- "@activatus/code-standards"
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
+
Newer pnpm versions may add this exclusion for you when you run `pnpm add`. Check the file either way, and add it if it is not there: `pnpm update` hits the same check when a new version of the standards has only just been published.
|
|
28
|
+
|
|
29
|
+
**pnpm owns `pnpm-workspace.yaml`** and rewrites it on every install, with single quotes, so `pnpm format:check` would fail after every update. Add the file to `.prettierignore`:
|
|
30
|
+
|
|
31
|
+
```text title=".prettierignore"
|
|
32
|
+
pnpm-workspace.yaml
|
|
33
|
+
```
|
|
34
|
+
|
|
27
35
|
The standards are now in `node_modules/@activatus/code-standards/`:
|
|
28
36
|
|
|
29
37
|
| Folder | What it holds |
|
|
@@ -100,25 +108,25 @@ The list has nothing about branches or commit messages. Those are the project's
|
|
|
100
108
|
|
|
101
109
|
### Working with the agent
|
|
102
110
|
|
|
103
|
-
Once the standards are agreed,
|
|
111
|
+
Once the standards are agreed, get the **project links**:
|
|
112
|
+
|
|
113
|
+
- **GitHub repo:** read it with `git remote get-url origin` and ask the person to confirm it. If there is no remote, ask for it.
|
|
114
|
+
- **Linear project:** if the project's own docs already name it, read it from there and ask the person to confirm it. Otherwise ask. Never copy it from another project. Write the workspace, the project and the ticket prefix, or "None" if the project does not use Linear.
|
|
115
|
+
|
|
116
|
+
Then **print this to the person exactly as it is written**:
|
|
104
117
|
|
|
105
118
|
```text
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
A. Status circles: report each ticket as one line
|
|
110
|
-
✅ done 🟢 Pull Request to review 🟣 working on it
|
|
111
|
-
🟡 ready to commit 🟠 waiting 🔴 blocked or you act
|
|
112
|
-
⚪ not started
|
|
113
|
-
B. Ask before every commit and push, every time
|
|
114
|
-
```
|
|
119
|
+
Status circles (optional). Want the agent to report each
|
|
120
|
+
ticket as one line, with a circle that says if you need to act?
|
|
115
121
|
|
|
116
|
-
|
|
122
|
+
✅ done 🟢 Pull Request to review 🟣 working on it
|
|
123
|
+
🟡 ready to commit 🟠 waiting 🔴 blocked or you act
|
|
124
|
+
⚪ not started
|
|
117
125
|
|
|
118
|
-
|
|
119
|
-
|
|
126
|
+
Yes or no?
|
|
127
|
+
```
|
|
120
128
|
|
|
121
|
-
**Record the answers** in the "Project workflow" section of `AGENTS.md`, from the template: the project links, the status circles if they said
|
|
129
|
+
**Record the answers** in the "Project workflow" section of `AGENTS.md`, from the template: the project links, and the status circles if they said yes. Delete the status circles section if they said no. Write the answer in `docs/development/coding-standards.md`, under "Details", so a later update knows not to ask again. See [Working with Agents](/docs/Standards/working-with-agents).
|
|
122
130
|
|
|
123
131
|
## 4. Apply the standards
|
|
124
132
|
|
|
@@ -163,7 +171,7 @@ The project already follows the standards, and a newer version is out.
|
|
|
163
171
|
pnpm update @activatus/code-standards --latest
|
|
164
172
|
```
|
|
165
173
|
|
|
166
|
-
Its major version is now the newest version.
|
|
174
|
+
Its major version is now the newest version. If pnpm refuses because the version is too new, or `pnpm format:check` now fails on `pnpm-workspace.yaml`, see [1. Install the standards](#1-install-the-standards).
|
|
167
175
|
|
|
168
176
|
3. **Read `node_modules/@activatus/code-standards/docs/version-history.md`**, but only the versions newer than the project's. Do not re-read the rest of the standards.
|
|
169
177
|
4. **Skip any change to a standard the project opted out of.** The opt-outs are listed in `docs/development/coding-standards.md`.
|
|
@@ -13,7 +13,7 @@ Every Activatus repository must have an `AGENTS.md` in its root. This file gives
|
|
|
13
13
|
|
|
14
14
|
Each project writes them up in its own docs, usually in `docs/development/`, and its `AGENTS.md` has a **Project workflow** section that points to them and states the rules an agent must follow. The most important one goes first: whether an agent may commit.
|
|
15
15
|
|
|
16
|
-
Project workflow also records the project's **GitHub repo** and **Linear project**, and
|
|
16
|
+
Project workflow also records the project's **GitHub repo** and **Linear project**, and the [status circles](/docs/Standards/working-with-agents#status-circles) if the project chose them during setup.
|
|
17
17
|
|
|
18
18
|
## Template
|
|
19
19
|
|
|
@@ -5,24 +5,24 @@ sidebar_label: "Working with Agents"
|
|
|
5
5
|
|
|
6
6
|
# Working with Agents
|
|
7
7
|
|
|
8
|
-
>
|
|
8
|
+
> How an AI agent links a project's work and reports on it. The project links are part of every setup; the status circles are optional, chosen during [Setup](/docs/Guides/setup#working-with-the-agent). Both work the same with Claude Code, ChatGPT, Codex or any agent that reads `AGENTS.md`.
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
Whatever the project chooses is written into the **Project workflow** section of its `AGENTS.md`, from the [template](/docs/templates#agents), so every agent in the project follows it.
|
|
11
11
|
|
|
12
12
|
## Project links
|
|
13
13
|
|
|
14
|
-
Every project records these two links in **Project workflow
|
|
14
|
+
Every project records these two links in **Project workflow**. An agent uses them to link tickets and Pull Requests, and to know where work belongs.
|
|
15
15
|
|
|
16
|
-
| Link | Where it comes from
|
|
17
|
-
| -------------- |
|
|
18
|
-
| GitHub repo | Read it from `git remote get-url origin` and confirm it with the person. If there is no remote, ask
|
|
19
|
-
| Linear project |
|
|
16
|
+
| Link | Where it comes from |
|
|
17
|
+
| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
18
|
+
| GitHub repo | Read it from `git remote get-url origin` and confirm it with the person. If there is no remote, ask |
|
|
19
|
+
| Linear project | If the project's own docs already name it, read it from there and confirm it with the person. Otherwise ask. Write the workspace, the project and the ticket prefix, such as `activatus-life`, Launchpad, `ACT`, or "None" |
|
|
20
20
|
|
|
21
21
|
**Never copy a Linear workspace or ticket prefix from another project.** Projects under the same organisation often live in different Linear workspaces or projects, and a guessed prefix files tickets in the wrong place. If `AGENTS.md` does not name the Linear project, ask before creating, linking or citing any ticket.
|
|
22
22
|
|
|
23
|
-
##
|
|
23
|
+
## Status circles
|
|
24
24
|
|
|
25
|
-
An agent reports the state of every ticket or piece of work as one line: a status circle, the ticket ID as a link, a short title and, where there is one, its Pull Request as a link. The colour alone tells the person whether they need to act.
|
|
25
|
+
Optional. An agent reports the state of every ticket or piece of work as one line: a status circle, the ticket ID as a link, a short title and, where there is one, its Pull Request as a link. The colour alone tells the person whether they need to act.
|
|
26
26
|
|
|
27
27
|
| Circle | Means |
|
|
28
28
|
| ------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
|
@@ -42,12 +42,4 @@ An agent reports the state of every ticket or piece of work as one line: a statu
|
|
|
42
42
|
- **No ticket is fine.** Work without one is just the circle and a short title.
|
|
43
43
|
- **Only what the person needs.** Leave out anything they already know.
|
|
44
44
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
An agent never commits or pushes without asking first, and waits for a clear yes to that specific action.
|
|
48
|
-
|
|
49
|
-
- **A yes covers one action.** Approval to commit and push one task does not carry over to the next, even in the same session. Ask every time.
|
|
50
|
-
- **Small changes too.** Docs-only changes and version bumps need a yes like anything else.
|
|
51
|
-
- **Ask plainly**, such as "Ready to commit and push. Want me to?"
|
|
52
|
-
|
|
53
|
-
This goes at the very top of `AGENTS.md`, as the project's most important rule for agents, and in **Who commits** under Project workflow.
|
|
45
|
+
Whether and when agents commit is not part of this. It is the project's own workflow, under **Who commits** in Project workflow.
|
package/docs/intro.md
CHANGED
|
@@ -22,7 +22,7 @@ This site documents the shared code standards used across all Activatus projects
|
|
|
22
22
|
| EditorConfig | [`.editorconfig`](/docs/Standards/editorconfig) | Editor-level whitespace rules |
|
|
23
23
|
| direnv + nvm | [`.envrc` / `.nvmrc`](/docs/Standards/direnv) | Automatic Node version switching on `cd` |
|
|
24
24
|
| AGENTS.md | [`AGENTS.md`](/docs/Standards/agent-specs) | AI agent context and agent skills |
|
|
25
|
-
| Working with Agents | [Optional](/docs/Standards/working-with-agents) |
|
|
25
|
+
| Working with Agents | [Optional](/docs/Standards/working-with-agents) | The project's GitHub repo and Linear project, and optional status circles |
|
|
26
26
|
| CSS Styling | [Styling guide](/docs/Standards/styling) | Tailwind CSS, flexbox-first layout and global colour variables |
|
|
27
27
|
| Tech Stack | [Tech stack](/docs/Standards/tech-stack) | The frameworks, libraries and versions we build on |
|
|
28
28
|
|
package/docs/version-history.md
CHANGED
|
@@ -18,7 +18,7 @@ sidebar_label: "Version History"
|
|
|
18
18
|
**Read only the versions newer than the project's.** A project on version 1 that is updating to version 3 reads version 2 and version 3 on this page, and nothing else. Do not re-read every standard or check the whole codebase: each version lists every change that matters, and how to find the code it affects.
|
|
19
19
|
|
|
20
20
|
1. **Find the project's version** in its `AGENTS.md`. If there is none, the project has never followed the standards: follow [Setup](/docs/Guides/setup) instead.
|
|
21
|
-
2. **Update the package:** `pnpm update @activatus/code-standards --latest`. Then read this page from `node_modules/@activatus/code-standards/docs/version-history.md`.
|
|
21
|
+
2. **Update the package:** `pnpm update @activatus/code-standards --latest`. If pnpm refuses because the version is too new, add the package to `minimumReleaseAgeExclude` in `pnpm-workspace.yaml`, as in [Setup](/docs/Guides/setup#1-install-the-standards). Then read this page from `node_modules/@activatus/code-standards/docs/version-history.md`.
|
|
22
22
|
3. **Read each version newer than the project's**, oldest first. Skip any change to a standard the project opted out of: they are listed in `docs/development/coding-standards.md`.
|
|
23
23
|
4. **For each change, do the "What to do" steps**, then run the "How to check" searches. A search that still finds something means the change is not finished. When a change says to copy a line from the `AGENTS.md` template, and the project's `AGENTS.md` records the standards in its own words instead, write the updated rule there in the project's own shape.
|
|
24
24
|
5. **Strike out what the standard now covers.** After the changes, re-read the project's list of opted-out and changed standards in `docs/development/coding-standards.md`. Take off the list any exception the new version has made part of the standard, and update any rule it records for an old shape of the standard. A differences list that still describes the old standard sends the next agent wrong.
|
|
@@ -41,24 +41,35 @@ Anyone changing the standards adds a version, alongside the change:
|
|
|
41
41
|
- **Work in progress goes under `## Version N — not released yet`**, with a line saying projects should not apply it yet. Changes can be added to it over time. To release it: pilot it (below), drop "not released yet", add the **Released** date and **Updates from** line, set `package.json` to `N.0.0`, then publish.
|
|
42
42
|
- **Pilot a version in a real project before releasing it.** Once the work-in-progress version is written, have one real project apply it exactly as written, reading only what the page says. Every judgement call the agent has to make, and every instruction that does not fit the project, is a missing sentence: fold it back into the version before publishing. Release only when the pilot runs without the agent asking a question the page does not answer.
|
|
43
43
|
- **Fixing a released version** bumps only the last number: `3.0.0` → `3.0.1`. Update the version's changes in place, and list what was fixed under its **Fixes**. Projects keep the same version number in `AGENTS.md`. Write each fix so a project already on that version knows what to do.
|
|
44
|
+
- **Every patch number is published.** Publish each patch to npm as soon as its Fixes are written. A Fixes entry for a version that was never published sends a project to install something that does not exist.
|
|
44
45
|
- **Judgement calls after release are fixes, not workarounds.** When a project's update needed a call the steps did not cover, add it under the version's Fixes so every other project gets it too. A project should never keep a private workaround for an unclear step.
|
|
45
46
|
|
|
46
47
|
---
|
|
47
48
|
|
|
48
49
|
## Version 3
|
|
49
50
|
|
|
50
|
-
**Released:** 2026-10-17 · **Updates from:** version 2 · **Latest fix:** 3.0.
|
|
51
|
+
**Released:** 2026-10-17 · **Updates from:** version 2 · **Latest fix:** 3.0.8
|
|
51
52
|
|
|
52
|
-
Install it with `pnpm add -D @activatus/code-standards@3.0.
|
|
53
|
+
Install it with `pnpm add -D @activatus/code-standards@3.0.8`. Do change 1 first: it says which parts of the project's `AGENTS.md` are now the project's own to write.
|
|
53
54
|
|
|
54
|
-
**Fixes in 3.0.
|
|
55
|
+
**Fixes in 3.0.8.** If the project already applied 3.0.7, check these:
|
|
55
56
|
|
|
56
|
-
-
|
|
57
|
-
-
|
|
57
|
+
- **Ask before every commit and push (option B) is gone.** Whether agents commit is the project's own workflow, as in change 1. If the project took B in 3.0.7, the rule stays only if the person wants it: it belongs under **Who commits** in Project workflow, in the project's own words. Remove the "Ask before every commit and push" section copied from the template, and take B off `docs/development/coding-standards.md`.
|
|
58
|
+
- **The Linear project can come from the project's own docs.** If they already name it, read it from there and confirm it with the person. Never copy it from another project.
|
|
59
|
+
- **`pnpm-workspace.yaml` is Prettier-ignored.** pnpm rewrites it with single quotes on every install, so `pnpm format:check` failed after every update. Add `pnpm-workspace.yaml` to `.prettierignore`.
|
|
60
|
+
- **The update steps cover pnpm's release-age check**: if pnpm refuses a version that has only just been published, add the package to `minimumReleaseAgeExclude`. See [Setup](/docs/Guides/setup#1-install-the-standards).
|
|
61
|
+
- 3.0.3 and 3.0.6 were never published to npm. Their fixes are in 3.0.4 and 3.0.7. Every patch is now published.
|
|
58
62
|
|
|
59
|
-
**How to check:**
|
|
63
|
+
**How to check:** `.prettierignore` lists `pnpm-workspace.yaml`, `pnpm format:check` passes, and `AGENTS.md` has no "Ask before every commit and push" section unless the person chose to keep that rule.
|
|
60
64
|
|
|
61
|
-
**Fixes in 3.0.
|
|
65
|
+
**Fixes in 3.0.7.** New, optional: [Working with Agents](/docs/Standards/working-with-agents). Setup now asks for the project's GitHub repo and Linear project, and offers status circles. (3.0.7 also offered asking before every commit and push. 3.0.8 removed it.) If the project already applied 3.0.5:
|
|
66
|
+
|
|
67
|
+
- Add **GitHub repo** and **Linear project** to the Project workflow section of `AGENTS.md`, from the [template](/docs/templates#agents). Read the repo from `git remote get-url origin` and confirm it with the person. Read the Linear project from the project's own docs if they name it, and confirm it; otherwise ask. Never copy it from another project.
|
|
68
|
+
- Print the [status circles](/docs/Guides/setup#working-with-the-agent) question to the person. If they say yes, copy the Status circles section from the template into Project workflow. Write their answer in `docs/development/coding-standards.md`, under "Details". If `AGENTS.md` already has status circles in the project's own words, keep that.
|
|
69
|
+
|
|
70
|
+
**How to check:** Project workflow in `AGENTS.md` names the GitHub repo and the Linear project, and `docs/development/coding-standards.md` records whether the project took the status circles.
|
|
71
|
+
|
|
72
|
+
**Fixes in 3.0.6.** Never published to npm: these fixes are in 3.0.7. Nothing to do in a project. The update steps gained two rules: when the project's `AGENTS.md` records the standards in its own words, an update writes the changed line in that shape; and after an update the project's list of opted-out and changed standards is re-read, taking off it anything the new version now covers. The 3.0.5 numbers change has its check spelled out: `pnpm lint` reporting a `no-magic-numbers` finding means it is not finished. A project-specific block in an ESLint config is now defined: it is recorded in the project's `docs/development/coding-standards.md`, or `pnpm lint` fails without it.
|
|
62
73
|
|
|
63
74
|
**Fixes in 3.0.5.** The ESLint configs now pass their own rules. Copied in as they were, they gave three problems on the config file itself: `No magic number: 3` (`no-magic-numbers`), and in Next.js projects two warnings, `import/no-anonymous-default-export` and `import-x/no-named-as-default-member`. Copy the new [ESLint config](/docs/Standards/eslint) for the project's framework over `eslint.config.mjs`, keeping any project-specific block: one that is recorded in the project's `docs/development/coding-standards.md`, or without which `pnpm lint` fails. A block that is neither, and the lint passes without it, is a leftover: ask before removing it. Then run `pnpm lint`: the config file itself has no problems. If the project already fixed these three by hand, there is nothing to do.
|
|
64
75
|
|
|
@@ -74,7 +85,7 @@ Install it with `pnpm add -D @activatus/code-standards@3.0.7`. Do change 1 first
|
|
|
74
85
|
- New standard 12.1: links, text and stand-in data live in `lib/constants/`, as `r`, `s` and noData. `r` and `s` are the only single-letter names allowed. Do change 11.
|
|
75
86
|
- The standards site has a home page, and the docs moved to `/docs/...`. Old links redirect, so nothing breaks. Update any link to the standards site in the project's `AGENTS.md` or docs to the `/docs/` address, such as `https://activatus-code-standards.vercel.app/docs/ontology`.
|
|
76
87
|
|
|
77
|
-
**Fixes in 3.0.3.** Change 8 now says how to type a function inside an object that is built somewhere else: give the function its own `Props` type, such as `LaunchSessionProps`, and use it. If the project wrote those parameter types out inline, such as `({ worktreePath }: { worktreePath: string })`, replace each with the function's `Props` type. Also new: type first, never `satisfies`. It is an ESLint error now, so copy the new ESLint config and replace each `satisfies` with a type on the declaration, except in Storybook story files.
|
|
88
|
+
**Fixes in 3.0.3.** Never published to npm: these fixes are in 3.0.4. Change 8 now says how to type a function inside an object that is built somewhere else: give the function its own `Props` type, such as `LaunchSessionProps`, and use it. If the project wrote those parameter types out inline, such as `({ worktreePath }: { worktreePath: string })`, replace each with the function's `Props` type. Also new: type first, never `satisfies`. It is an ESLint error now, so copy the new ESLint config and replace each `satisfies` with a type on the declaration, except in Storybook story files.
|
|
78
89
|
|
|
79
90
|
**Fixes in 3.0.2.** Nothing to do in a project:
|
|
80
91
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@activatus/code-standards",
|
|
3
|
-
"version": "3.0.
|
|
3
|
+
"version": "3.0.8",
|
|
4
4
|
"description": "The Activatus code standards: the rules as Markdown, and the config files to copy. Install it so an AI agent can read the standards from node_modules.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -47,7 +47,7 @@
|
|
|
47
47
|
- **Pull requests**: [review and CI requirements, and where Pull Requests merge to]
|
|
48
48
|
- **Merging and releases**: [merge strategy, and how work reaches production]
|
|
49
49
|
- **GitHub repo**: [https://github.com/organisation/repo, read from the git remote and confirmed with the person]
|
|
50
|
-
- **Linear project**: [workspace, project and ticket prefix, such as `activatus-life`, Launchpad, `ACT
|
|
50
|
+
- **Linear project**: [workspace, project and ticket prefix, such as `activatus-life`, Launchpad, `ACT`, read from the project's docs or asked for, and confirmed with the person. Or "None"]
|
|
51
51
|
|
|
52
52
|
**Never copy a Linear workspace or ticket prefix from another project.** If the Linear project above is missing, ask before creating, linking or citing any ticket.
|
|
53
53
|
|
|
@@ -73,12 +73,6 @@ Example: `🟢 [ABC-12](https://linear.app/[workspace]/issue/ABC-12) Short title
|
|
|
73
73
|
- Work with no ticket is just the circle and a short title.
|
|
74
74
|
- Only what the person needs to act on. Leave out what they already know.
|
|
75
75
|
|
|
76
|
-
### Ask before every commit and push
|
|
77
|
-
|
|
78
|
-
[Only if the person chose this during setup. Otherwise delete this section. When it stays, also make it the first line of this file.]
|
|
79
|
-
|
|
80
|
-
Never commit or push without asking first, and wait for a clear yes to that specific action. A yes covers one action: approval for one task does not carry over to the next, even in the same session. Docs-only changes and version bumps need a yes too.
|
|
81
|
-
|
|
82
76
|
## Environment variables
|
|
83
77
|
|
|
84
78
|
| Variable | Required | Description |
|