mirror of
https://github.com/jparkerweb/plan2code.git
synced 2026-07-21 18:33:22 -07:00
prompts: drop Git Commit Messages section from AGENTS.md and init flows
Project-specific commit conventions don't belong in the generic init templates. AGENTS.md, init, and init-update no longer mention or audit a Git Commit Messages section.
This commit is contained in:
@@ -44,23 +44,6 @@ Language/toolchain conventions for `install.js` vs TypeScript packages, and pitf
|
|||||||
|
|
||||||
Details: [Code Style & Gotchas](./.agents-docs/AGENTS-code-style.md)
|
Details: [Code Style & Gotchas](./.agents-docs/AGENTS-code-style.md)
|
||||||
|
|
||||||
## Git Commit Messages
|
|
||||||
|
|
||||||
- **Commit message format:**
|
|
||||||
```
|
|
||||||
<description of what this commit is about>
|
|
||||||
|
|
||||||
<JIRA-Ticket-ID>
|
|
||||||
AI Assisted
|
|
||||||
```
|
|
||||||
- **JIRA ticket ID:** Derive the ticket ID from the current branch name. The branch format is `<prefix>/<TICKET-ID>-description`, where the ticket ID is an uppercase project key followed by a hyphen and integer (e.g., `PCWEB-10968`, `ABC-123`).
|
|
||||||
- **AI Assisted footer:** Always the last line of every commit message.
|
|
||||||
- **Commit paths:** This is enforced across all commit surfaces:
|
|
||||||
- Loop task mode: `createTaskCommit()` in `plan2code-loop/src/utils/git.ts` appends the footer automatically
|
|
||||||
- Loop phase mode: Prompt template instructs the LLM to follow the format above
|
|
||||||
- Implement mode: User-facing commit suggestions in `src/plan2code-3--implement.md` follow the format above
|
|
||||||
- **Init workflow:** `src/plan2code---init.md` generates AGENTS.md files with a Git Commit Messages section that includes this convention by default
|
|
||||||
|
|
||||||
## Mascot
|
## Mascot
|
||||||
|
|
||||||
The project has a mascot called "Planny" - an ASCII art robot that appears in installer output and workflow prompts. Mascot variants are defined in `MASCOT` constant in `install.js` and appear in workflow markdown files.
|
The project has a mascot called "Planny" - an ASCII art robot that appears in installer output and workflow prompts. Mascot variants are defined in `MASCOT` constant in `install.js` and appear in workflow markdown files.
|
||||||
|
|||||||
@@ -42,24 +42,6 @@ Section files:
|
|||||||
|
|
||||||
Wait for user response before continuing. If user accepts, restructure existing content: create `.agents-docs/` directory with section files, convert AGENTS.md to index with summaries and links. Always-inline sections (Project Overview, Git Commit Messages, How to Use This File) stay in AGENTS.md. If user declines, continue with single-file editing.
|
Wait for user response before continuing. If user accepts, restructure existing content: create `.agents-docs/` directory with section files, convert AGENTS.md to index with summaries and links. Always-inline sections (Project Overview, Git Commit Messages, How to Use This File) stay in AGENTS.md. If user declines, continue with single-file editing.
|
||||||
|
|
||||||
### Git Commit Messages Audit
|
|
||||||
|
|
||||||
Check AGENTS.md for a `## Git Commit Messages` section describing this format:
|
|
||||||
```
|
|
||||||
<description>
|
|
||||||
|
|
||||||
<JIRA-Ticket-ID>
|
|
||||||
AI Assisted
|
|
||||||
```
|
|
||||||
Required rules:
|
|
||||||
1. **JIRA ticket ID from branch** — derive from branch name format `<prefix>/<TICKET-ID>-description` (uppercase project key + hyphen + integer, e.g., `PCWEB-10968`)
|
|
||||||
2. **AI Assisted footer** — always the last line, on its own line directly after the ticket ID
|
|
||||||
|
|
||||||
If the section is missing or either rule is absent, flag it:
|
|
||||||
> "Your Git Commit Messages section is missing [missing items]. Want me to add them?"
|
|
||||||
|
|
||||||
If user confirms, add/update the section before proceeding. If user declines, continue.
|
|
||||||
|
|
||||||
Proceed to Step 2.
|
Proceed to Step 2.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -16,8 +16,7 @@ Analyze this codebase and create `AGENTS.md` to guide future AI coding agents (C
|
|||||||
|
|
||||||
1. **Commands**: Build, lint, test, run single test, and other common development tasks
|
1. **Commands**: Build, lint, test, run single test, and other common development tasks
|
||||||
2. **Architecture**: High-level "big picture" structure requiring multi-file context to understand
|
2. **Architecture**: High-level "big picture" structure requiring multi-file context to understand
|
||||||
3. **Git Commit Messages**: All commits must follow this format: `<description>\n\n<JIRA-Ticket-ID>\nAI Assisted`. Derive the JIRA ticket ID from the current branch name — the format is `<prefix>/<TICKET-ID>-description` where the ticket ID is an uppercase project key, hyphen, and integer (e.g., `PCWEB-10968`). The ticket ID and `AI Assisted` go on consecutive lines after a blank line.
|
3. **How to Use This File**: A short paragraph explaining that sections below contain brief summaries and agents should follow the markdown links to `.agents-docs/` for full details — only read what's relevant to the current task.
|
||||||
4. **How to Use This File**: A short paragraph explaining that sections below contain brief summaries and agents should follow the markdown links to `.agents-docs/` for full details — only read what's relevant to the current task.
|
|
||||||
|
|
||||||
## Rules
|
## Rules
|
||||||
|
|
||||||
@@ -53,7 +52,6 @@ Generate AGENTS.md as an **index file** — each section gets a 2-3 line summary
|
|||||||
|
|
||||||
These sections must remain fully inline in AGENTS.md (never split to separate files):
|
These sections must remain fully inline in AGENTS.md (never split to separate files):
|
||||||
- Project Overview
|
- Project Overview
|
||||||
- Git Commit Messages
|
|
||||||
- How to Use This File
|
- How to Use This File
|
||||||
|
|
||||||
### Directory Setup
|
### Directory Setup
|
||||||
|
|||||||
Reference in New Issue
Block a user