Skip to content

Commit 3ee902a

Browse files
committed
Expand feature-driven-flow README with clearer workflow and rule guidance
- Add detailed descriptions for skills, prompt, shared rules, and local rule overlays - Clarify install and usage steps, including scope-to-phase behavior - Explain rule model fields and precedence conflict handling - Extend diagnostics with guidance for blocked phases and under-specified outputs - Add creator LinkedIn profile link
1 parent 78a1a50 commit 3ee902a

File tree

1 file changed

+28
-18
lines changed

1 file changed

+28
-18
lines changed

README.md

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
# Codex Feature-Driven-Flow
22

33
Script-free Codex package for one-command feature workflow orchestration with a rules-based extension system.
4+
It is designed to keep feature delivery predictable by combining a minimal core workflow with declarative rules that can be shared or overridden per repository.
45

56
## Includes
67

78
1. Skills:
8-
- `skills/feature-driven-flow`
9-
- `skills/fdf-code-explorer`
10-
- `skills/fdf-implementation-planner`
11-
- `skills/fdf-change-auditor`
9+
- `skills/feature-driven-flow`: main conductor skill that drives the seven-phase workflow and gate checks.
10+
- `skills/fdf-code-explorer`: specialist skill for mapping current behavior and code paths before planning changes.
11+
- `skills/fdf-implementation-planner`: specialist skill for turning clarified requirements into a file-by-file implementation plan.
12+
- `skills/fdf-change-auditor`: specialist skill for reviewing completed changes, risks, and verification coverage.
1213
2. Prompt:
13-
- `prompts/feature-driven-flow.md`
14+
- `prompts/feature-driven-flow.md`: entrypoint that activates the conductor workflow in Codex.
1415
3. Shared rules:
15-
- `skills/feature-driven-flow/extensions/rules/*.md`
16+
- `skills/feature-driven-flow/extensions/rules/*.md`: reusable rule set for phase behavior, checks, and expected outputs.
1617
4. Optional repository-local rules:
17-
- `<repo>/.codex/feature-driven-flow/rules/*.md`
18+
- `<repo>/.codex/feature-driven-flow/rules/*.md`: local policy overlays that refine shared rules for a specific codebase.
1819

1920
## Install
2021

@@ -28,10 +29,10 @@ codex --help
2829
3. Create folders:
2930
- `CODEX_HOME/skills`
3031
- `CODEX_HOME/prompts`
31-
4. Copy:
32+
4. Copy package assets:
3233
- `codex/feature-driven-flow/skills/*` -> `CODEX_HOME/skills/`
3334
- `codex/feature-driven-flow/prompts/*.md` -> `CODEX_HOME/prompts/`
34-
5. Restart Codex session.
35+
5. Restart Codex session so newly installed prompt and skills are detected.
3536

3637
## Use
3738

@@ -41,7 +42,7 @@ Run the prompt:
4142
/prompts:feature-driven-flow Implement financial services
4243
```
4344

44-
Select shared rules in the request:
45+
Select shared rules in the request to control phase behavior:
4546

4647
```text
4748
/prompts:feature-driven-flow Implement financial services using rules scope-baseline, explore-baseline, clarify-policy, architect-policy, implement-baseline, verify-policy, summarize-policy, security-baseline
@@ -54,6 +55,7 @@ Repository-local baseline rule (auto-applied when present):
5455
```
5556

5657
At Scope, Codex infers execution context and proposes a phase-by-phase rule matrix. The user can accept or adjust before Explore.
58+
The workflow then proceeds through seven phases with explicit gates, checklist-based readiness, and approval points before implementation.
5759

5860
## Core vs Rules
5961

@@ -67,18 +69,19 @@ Core is a light skeleton that enforces:
6769
6. Checklist-driven gates where phase checklist items are derived from active rule `checks`.
6870

6971
Everything else should live in rules.
72+
This separation keeps core behavior stable while allowing teams to evolve policy without editing conductor logic.
7073

7174
## Simple Rule Model
7275

7376
Each rule should define:
7477

75-
1. `id`
76-
2. `title`
77-
3. `applies_to_phases`
78-
4. `intent`
79-
5. `guidance`
80-
6. `checks` (also used to derive phase checklist items)
81-
7. `outputs`
78+
1. `id`: unique, stable rule identifier used in matrices and traceability.
79+
2. `title`: short human-readable name.
80+
3. `applies_to_phases`: one or more phases where the rule is active.
81+
4. `intent`: what the rule is trying to guarantee.
82+
5. `guidance`: concrete instructions Codex should follow when the rule is active.
83+
6. `checks` (also used to derive phase checklist items): verifiable conditions that determine whether a phase can pass.
84+
7. `outputs`: artifacts or structured results expected from the phase when the rule applies.
8285
8. `examples` (optional)
8386

8487
## Rule Precedence
@@ -87,10 +90,17 @@ Each rule should define:
8790
2. Repository policy constraints in `AGENTS.md`.
8891
3. User-confirmed phase-by-phase rule matrix.
8992
4. Within active rules, repository-local rules refine shared rules.
93+
When instructions conflict, Codex should prioritize higher-precedence sources and ask for clarification if a conflict cannot be safely resolved.
9094

9195
## Diagnostics
9296

9397
1. If `codex` is not found, run `codex --help`.
9498
2. If prompt does not appear, confirm `CODEX_HOME/prompts/feature-driven-flow.md` exists and restart.
9599
3. If shared rules are not detected, check `CODEX_HOME/skills/feature-driven-flow/extensions/rules/`.
96-
4. If local baseline rule is not applied, check `<repo>/.codex/feature-driven-flow/rules/project-baseline.md`.
100+
4. If local baseline rule is not applied, check `<repo>/.codex/feature-driven-flow/rules/project-baseline.md`.
101+
5. If outputs look under-specified, include explicit rule IDs in your prompt instead of relying on defaults.
102+
6. If a phase is blocked, inspect active rule `checks` first, then resolve missing inputs or approvals.
103+
104+
## Creator
105+
106+
- LinkedIn: https://www.linkedin.com/in/taluyev/

0 commit comments

Comments
 (0)