final cleanup ready for initial release

This commit is contained in:
Brian Madison
2025-04-13 17:56:54 -05:00
parent 765e928647
commit c709dec61e
15 changed files with 11 additions and 9 deletions

BIN
.ai-pm/.DS_Store vendored

Binary file not shown.

View File

@@ -6,9 +6,11 @@ Join in on the [Community Discussion Forum](https://github.com/bmadcode/BMAD-MET
Also check out [Part 1 on the BMad Code YouTube channel](https://youtu.be/JbhiLUY_V2U) - feel free to comment, like, and subscribe also for future videos and updates.
Bonus - check the prompts folder for a set of Google Gemini Gems to use with this workflow! Optional and a totally different fun experience.
**Super Quick TLDR:** These are [the prompts](./ai-pm/prompts/) you have been searching for!
Note: Depending on which tool you use - the prompts folder should be set to be ignored my your LLM codebase indexing (ie with cursor add them to cursorindexingignore) along with the story files potentially.
**Bonus** - check the [Gemini Gems Demo Prompts](./ai-pm/prompts/Gemini%20Gems%20Agile%20Masters.md) for a set of Google Gemini Gems to use with this workflow! Optional and a totally different fun experience.
Note: Depending on which tool you use - the [[prompts folder]](./ai-pm/prompts/) should be set to be ignored my your LLM codebase indexing (ie with cursor add them to .cursorindexingignore - cline and roo may differ).
## Overview
@@ -45,7 +47,7 @@ The BMad Method follows a structured workflow:
## Prompt Sequence
The `.ai-pm/prompts` folder contains carefully crafted prompts for each phase of development.
The `ai-pm/prompts` folder contains carefully crafted prompts for each phase of development.
This is for the most broadly ambitious project MVP - see the simplified prompts
1. **Research Assistant: Analysis** (`0-research-assistant.md`): Optional deep research on your product concept
@@ -74,7 +76,7 @@ Recommend checking out this video series starting with [Part 1 on the BMad Code
But the **Quick and Dirt**y is:
1. Clone this project
2. Start with the first prompt in `.ai-pm/prompts/0-research-assistant.md` (or skip to 1 if research isn't needed)
2. Start with the first prompt in `ai-pm/prompts/0-research-assistant.md` (or skip to 1 if research isn't needed)
3. Follow each prompt in sequence, providing output from previous steps as context to the new prompt when indicated in the current prompt
4. Once all stories are drafted by the final prompts of the SM, move generated stories through the Kanban folders as they are implemented - meaning drag the first story to InProgress, start a Agent chat and direct it to that story. Optionally, use the sample workflow (coming soon) to automate (I prefer the manual nature of dragging each item).
5. Track progress until all stories are in the `3-Done` folder
@@ -87,7 +89,7 @@ If you have a subscription to one of those or even free tier access to the best
Similar idea if you use the optional UX prompt, take advantage of free tier V0 or similar products to past in the produce prompt to quick start complex UI's.
Either way, ensure you are adding all of the artifacts to the .ai-pm folder (or another folder of your choice) for your new project.
Either way, ensure you are adding all of the artifacts to the ai-pm folder (or another folder of your choice) for your new project.
## Future Enhancements

View File

@@ -63,7 +63,7 @@ Your goal is to collaboratively design and document an opinionated Architecture
- **Frameworks/Libraries:** Mandate specific testing tools and **versions** (e.g., Jest v29.x, Cypress v12.x, Pytest v7.x).
- **Code Coverage Requirement:** State the mandatory minimum code coverage percentage (e.g., >= 85%) that must be enforced via CI.
- **Testing Standards:** Define conventions (e.g., AAA pattern for unit tests, standard setup/teardown procedures, mocking guidelines).
9. **Core AI Agent Rules (for separate file):** Define a minimal set (3-5) of essential, project-wide rules for the AI agent based on the finalized tech stack and standards decided above. These rules are intended for a separate file (e.g., `.ai/rules.md`). Examples:
9. **Core AI Agent Rules (for separate file):** Define a minimal set (3-5) of essential, project-wide rules for the AI agent based on the finalized tech stack and standards decided above. These rules are intended for a separate file (e.g., `ai/rules.md`). Examples:
- "Always place unit test files (`*.test.ts` or `*.spec.ts`) adjacent to the source file they test."
- "Adhere strictly to the configured Prettier settings found in `.prettierrc`."
- "Use kebab-case for all new component filenames (e.g., `my-component.tsx`)."

View File

@@ -42,7 +42,7 @@ Your task is to generate a complete, detailed stories.md file for the AI coding
### Output Format
Generate a single Markdown file named stories.md (e.g., `STORY-123.md`) containing the following sections for each story - the story files all need to go into the .ai-pm/1-ToDo/ folder at the root of the project:
Generate a single Markdown file named stories.md (e.g., `STORY-123.md`) containing the following sections for each story - the story files all need to go into the ai-pm/1-ToDo/ folder at the root of the project:
1. **Story ID:** `<Story_ID>`
2. **Epic ID:** `<Epic_ID>`

View File

@@ -4,7 +4,7 @@ Depending on which LLM and IDE you are using, you might want to split up your st
## Prompt Follows for IDE Agent (Such as Claude 3.5 or 3.7):
Review ./.ai-pm/stories.md and without changing ANY content, generate all of the
Review ./ai-pm/stories.md and without changing ANY content, generate all of the
individual story files to add to ./ai-pm/1-ToDo/. Each story in the file has a title, which will drive the file name. And each story has a separator between each story block. The content for each story block will be the only contents within each file you will create.
Each story block starts with **Story ID:** `<Story_ID>`, the file you will create for that block will be `<Story_ID>`.md.

View File

@@ -145,7 +145,7 @@ This comprehensive Architect Gem handles both deep technical research and opinio
6. Patterns and Standards (Chosen architectural patterns, coding standards, design principles \- opinionated & specific)
7. Folder Structure (Mandatory top-level layout)
8. Testing Strategy (Types of tests, tools, coverage expectations)
9. Core AI Agent Rules (If applicable, minimal set for .ai/rules.md based on stack/standards)
9. Core AI Agent Rules (If applicable, minimal set for ai/rules.md based on stack/standards)
10. Security Considerations (Key security principles, mechanisms, compliance points) 30
11. Architectural Decisions (Log of key decisions and rationale \- ADRs)
12. Glossary (Definitions of key terms)