@reforma/agentflow 0.0.1 → 1.0.0

package/README.md

@@ -44,7 +44,7 @@ Reusable agent skills are published from `skills/`:
 
 ---
 
-## The Loop
+## 🔄 The Loop
 
 Research helps when the agent does not know the area, and most larger tasks also need a plan. But almost every task goes through Grill. Small, obvious changes can go straight from Grill to implementation.
 
@@ -58,7 +58,7 @@ Research helps when the agent does not know the area, and most larger tasks also
 
 Repeat steps 4–7 until every PR in the plan is complete.
 
-### Step 1. Learn how it works (optional)
+### Step 1. 🔍 Learn how it works (optional)
 
 Research does not require a skill. Even a simple prompt like "Find out how
 authentication works in this project" can make the implementation much easier.
@@ -73,7 +73,7 @@ context compaction or in a new chat.
 
 Even if you skip this step, Grill will fill in any gaps.
 
-### Step 2. Sharpen the idea with Grill
+### Step 2. 🔥 Sharpen the idea with Grill
 
 Grill is the core of AgentFlow and the one step used for the most tasks.
 
@@ -87,7 +87,7 @@ until nothing important is left unclear.
 This gives the implementation an agreed starting point instead of leaving the
 agent to fill in gaps on its own.
 
-### Step 3. Plan and slice the work into PRs
+### Step 3. 🗂️ Plan and slice the work into PRs
 
 For a larger task, planning usually follows Grill in the same chat. If you asked
 Grill to plan next, it loads `/plan` automatically. You can also run `/plan`
@@ -113,10 +113,7 @@ that first uses them instead of becoming placeholder PRs.
 
 Keep the plan updated as the work changes.
 
-**Done when:** someone can open the plan, find the next PR, and see how to
-verify it.
-
-### Step 4. Implement one PR
+### Step 4. 🛠️ Implement one PR
 
 Implement the first unchecked PR and nothing beyond it. Without a plan, keep the
 change small enough to review. You can stay in the current chat, start a fresh
@@ -126,34 +123,28 @@ to another chat. Use `/tdd` for test-first work.
 Load any relevant skills named in `AGENTS.md`. If work spills into a later PR,
 update the plan instead of silently expanding the current one.
 
-**Done when:** the PR does what the plan promised, and the plan matches the work.
+Before review, update `plan.md`: check the completed PR only after its
+done-when and verification pass, then apply any scope changes to later rows.
 
-### Step 5. Agent review
+### Step 5. 🤖 Agent review
 
 Run `/code-review` on the completed PR. It looks for code to reuse, unnecessary
 wrappers, and avoidable complexity. It fixes small local problems and returns a
 verdict: keep, shrink, or burn.
 
-**Done when:** the review has run and its local fixes are applied.
-
-### Step 6. Your review, then commit
+### Step 6. ✅ Your review, then commit
 
 Read the diff yourself, then commit it using the project's normal workflow.
 
-**Done when:** the PR is reviewed and committed.
-
-### Step 7. Refresh the context when needed
+### Step 7. 🔄 Refresh the context when needed
 
 Keep the current chat if it still has useful context. When it gets noisy,
 summarize it or start a fresh one. Run `/handoff` to save what shipped, what
 changed, and which PR comes next.
 
-Attach the plan and handoff to a fresh chat when they exist.
+Attach the plan and handoff to a fresh chat when they exist, then return to step 4.
 
-**Done when:** you can start the next PR without reconstructing the previous
-work. Return to step 4.
-
-## Install
+## 📦 Install
 
 Install the complete workflow in a project:
 
@@ -185,7 +176,7 @@ npx skills update plan
 
 ---
 
-## Why AgentFlow?
+## 💡 Why AgentFlow?
 
 Coding agents can handle large changes, but chat history is a poor place to
 keep requirements, scope, and decisions. AgentFlow moves that information into
@@ -202,7 +193,7 @@ small files and gives each PR a clear boundary.
   fixed, while the documentation is limited to one plan and one current
   handoff.
 
-### How we compare
+### ⚖️ How we compare
 
 OpenSpec and Spec Kit try to cover most of spec-driven development with their
 own commands, templates, and artifacts. AgentFlow does not try to be an
@@ -225,7 +216,7 @@ fix. On larger changes, AgentFlow keeps decisions out of transient history,
 limits scope to one reviewable slice, and gives the next session a reliable
 starting point.
 
-## Releasing
+## 🚀 Releasing
 
 Add a changeset with every publishable change:
 
@@ -238,9 +229,6 @@ updates its version and changelog, publishes it to npm through trusted
 publishing, and commits the release files back to `main`. A separate job then
 publishes the matching versioned Agent Skills release on GitHub.
 
-The npm trusted publisher for `@reforma/agentflow` must point at
-`reforma-dev/agentflow/.github/workflows/publish_npm.yml`.
-
 Validate a release locally without publishing:
 
 ```bash
@@ -249,4 +237,12 @@ bun run test
 bun publish --dry-run
 ```
 
+## 📖 License
+
 AgentFlow is available under the [MIT License](LICENSE).
+
+## 👤 Maintainer
+
+<img src="https://github.com/kachurun.png" width="100" height="100" alt="@kachurun's avatar" style="border-radius: 50%;">
+
+Maintained with ❤️ by [@kachurun](https://github.com/kachurun)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reforma/agentflow",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "description": "An opinionated workflow for shipping production-ready changes with coding agents.",
   "author": "Reforma, Inc. <dev@reforma.ai>",
   "type": "module",
@@ -14,6 +14,7 @@
     "LICENSE"
   ],
   "scripts": {
+    "prepare": "node -e \"if (process.env.CI === 'true' || process.env.SKIP_GIT_HOOKS === '1') process.exit(0); require('child_process').execSync('bunx simple-git-hooks', {stdio:'inherit'})\"",
     "build": "bun build src/bin.ts --target=node --outfile=bin/agentflow.js --external skills",
     "typecheck": "tsc --noEmit",
     "changeset": "bunx @changesets/cli",
@@ -23,6 +24,9 @@
     "validate:skills": "gh skill publish --dry-run",
     "prepublishOnly": "bun run typecheck && bun run test && bun run build"
   },
+  "simple-git-hooks": {
+    "commit-msg": "bunx --no-install commitlint --edit \"$1\""
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/reforma-dev/agentflow.git"
@@ -48,8 +52,64 @@
   },
   "devDependencies": {
     "@changesets/cli": "3.0.1",
+    "@commitlint/cli": "21.2.2",
+    "@commitlint/config-conventional": "21.2.2",
     "@types/bun": "1.4.0",
     "@types/node": "26.4.0",
+    "simple-git-hooks": "2.14.0",
     "typescript": "7.0.2"
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ],
+    "rules": {
+      "type-enum": [
+        2,
+        "always",
+        [
+          "feat",
+          "fix",
+          "chore",
+          "refactor",
+          "docs",
+          "test",
+          "ci",
+          "perf",
+          "revert"
+        ]
+      ],
+      "type-case": [
+        2,
+        "always",
+        "lower-case"
+      ],
+      "type-empty": [
+        2,
+        "never"
+      ],
+      "subject-empty": [
+        2,
+        "never"
+      ],
+      "subject-min-length": [
+        1,
+        "always",
+        4
+      ],
+      "body-max-line-length": [
+        1,
+        "always",
+        250
+      ],
+      "subject-case": [
+        2,
+        "never",
+        [
+          "pascal-case",
+          "upper-case"
+        ]
+      ]
+    }
   }
 }

package/skills/plan/SKILL.md

@@ -26,6 +26,10 @@ plan.
 ```markdown
 # <Feature>
 
+> Keep this plan current during implementation.
+> Check a PR only after its done-when and verification pass.
+> Record scope changes before leaving the PR.
+
 **Goal:** one sentence
 **Approach:** 2–3 sentences — the chosen reading
 **Reuse:** existing APIs this plan calls (`path`)