owflow 0.5.0 → 0.7.0
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/LICENSE +21 -21
- package/README.md +448 -261
- package/dist/agents/bottleneck-analyzer.md +332 -329
- package/dist/agents/code-quality-pragmatist.md +353 -354
- package/dist/agents/code-reviewer.md +238 -239
- package/dist/agents/codebase-analysis-reporter.md +245 -246
- package/dist/agents/docs-operator.md +22 -23
- package/dist/agents/e2e-test-verifier.md +447 -448
- package/dist/agents/gap-analyzer.md +501 -502
- package/dist/agents/implementation-completeness-checker.md +219 -220
- package/dist/agents/implementation-planner.md +308 -309
- package/dist/agents/information-gatherer.md +690 -691
- package/dist/agents/production-readiness-checker.md +278 -279
- package/dist/agents/project-analyzer.md +403 -403
- package/dist/agents/reality-assessor.md +365 -366
- package/dist/agents/research-planner.md +449 -450
- package/dist/agents/research-synthesizer.md +402 -403
- package/dist/agents/solution-brainstormer.md +256 -257
- package/dist/agents/solution-designer.md +371 -372
- package/dist/agents/spec-auditor.md +297 -298
- package/dist/agents/specification-creator.md +333 -334
- package/dist/agents/task-classifier.md +449 -450
- package/dist/agents/task-group-implementer.md +283 -284
- package/dist/agents/test-suite-runner.md +194 -195
- package/dist/agents/user-docs-generator.md +508 -509
- package/dist/commands/reviews-code.md +90 -90
- package/dist/commands/reviews-pragmatic.md +99 -99
- package/dist/commands/reviews-production-readiness.md +113 -113
- package/dist/commands/reviews-reality-check.md +110 -110
- package/dist/commands/reviews-spec-audit.md +114 -114
- package/dist/commands/work.md +280 -280
- package/dist/configuration/agents-config.d.ts +2 -0
- package/dist/configuration/agents-config.js +8 -44
- package/dist/configuration/commands-config.d.ts +23 -0
- package/dist/configuration/commands-config.js +17 -17
- package/dist/configuration/skills-config.d.ts +2 -0
- package/dist/configuration/skills-config.js +3 -3
- package/dist/hooks/hooks-diagnostics.d.ts +3 -0
- package/dist/hooks/hooks-diagnostics.js +21 -0
- package/dist/hooks/hooks-persistence.d.ts +17 -0
- package/dist/hooks/hooks-persistence.js +207 -0
- package/dist/hooks/hooks-registry.d.ts +6 -0
- package/dist/hooks/hooks-registry.js +104 -0
- package/dist/hooks/hooks-wrapper.d.ts +25 -0
- package/dist/hooks/hooks-wrapper.js +318 -0
- package/dist/hooks/internal/before-tool.d.ts +6 -0
- package/dist/hooks/internal/before-tool.js +13 -0
- package/dist/hooks/internal/session-compaction.d.ts +9 -0
- package/dist/hooks/{session-compaction.js → internal/session-compaction.js} +9 -7
- package/dist/hooks/runtime/circuit-breaker.d.ts +23 -0
- package/dist/hooks/runtime/circuit-breaker.js +39 -0
- package/dist/hooks/runtime/failure-policy.d.ts +15 -0
- package/dist/hooks/runtime/failure-policy.js +49 -0
- package/dist/hooks/runtime/process-executor.d.ts +33 -0
- package/dist/hooks/runtime/process-executor.js +147 -0
- package/dist/hooks/runtime/status-recorder.d.ts +27 -0
- package/dist/hooks/runtime/status-recorder.js +111 -0
- package/dist/index.d.ts +7 -0
- package/dist/index.js +111 -40
- package/dist/skills/agents-md-generator/SKILL.md +223 -223
- package/dist/skills/codebase-analyzer/SKILL.md +162 -162
- package/dist/skills/codebase-analyzer/references/code-analysis.md +63 -63
- package/dist/skills/codebase-analyzer/references/combined.md +31 -31
- package/dist/skills/codebase-analyzer/references/context-discovery.md +63 -63
- package/dist/skills/codebase-analyzer/references/file-discovery.md +51 -51
- package/dist/skills/codebase-analyzer/references/migration-target.md +23 -23
- package/dist/skills/codebase-analyzer/references/pattern-mining.md +22 -22
- package/dist/skills/dev-analyze/SKILL.md +115 -115
- package/dist/skills/dev-bugfix/SKILL.md +452 -452
- package/dist/skills/dev-finalize/SKILL.md +118 -118
- package/dist/skills/dev-implement/SKILL.md +167 -167
- package/dist/skills/dev-plan/SKILL.md +147 -147
- package/dist/skills/dev-spec/SKILL.md +182 -182
- package/dist/skills/dev-tdd-red/SKILL.md +94 -94
- package/dist/skills/dev-verify/SKILL.md +153 -153
- package/dist/skills/development/SKILL.md +260 -260
- package/dist/skills/diagrams-mermaid/SKILL.md +183 -159
- package/dist/skills/diagrams-mermaid/references/reference.md +220 -148
- package/dist/skills/docs-manager/SKILL.md +379 -379
- package/dist/skills/docs-manager/docs/INDEX.md +199 -199
- package/dist/skills/docs-manager/docs/standards/backend/api.md +25 -25
- package/dist/skills/docs-manager/docs/standards/backend/migrations.md +22 -22
- package/dist/skills/docs-manager/docs/standards/backend/models.md +25 -25
- package/dist/skills/docs-manager/docs/standards/backend/queries.md +22 -22
- package/dist/skills/docs-manager/docs/standards/frontend/accessibility.md +25 -25
- package/dist/skills/docs-manager/docs/standards/frontend/components.md +28 -28
- package/dist/skills/docs-manager/docs/standards/frontend/css.md +16 -16
- package/dist/skills/docs-manager/docs/standards/frontend/responsive.md +28 -28
- package/dist/skills/docs-manager/docs/standards/global/coding-style.md +25 -25
- package/dist/skills/docs-manager/docs/standards/global/commenting.md +10 -10
- package/dist/skills/docs-manager/docs/standards/global/conventions.md +31 -31
- package/dist/skills/docs-manager/docs/standards/global/error-handling.md +22 -22
- package/dist/skills/docs-manager/docs/standards/global/minimal-implementation.md +22 -22
- package/dist/skills/docs-manager/docs/standards/global/validation.md +28 -28
- package/dist/skills/docs-manager/docs/standards/testing/test-writing.md +25 -25
- package/dist/skills/docs-manager/references/agents-md-template.md +29 -29
- package/dist/skills/docs-manager/references/index-md-template.md +73 -73
- package/dist/skills/flow-init/SKILL.md +234 -234
- package/dist/skills/flow-init/references/architecture-template.md +45 -45
- package/dist/skills/flow-init/references/roadmap-templates.md +93 -93
- package/dist/skills/flow-init/references/tech-stack-template.md +70 -70
- package/dist/skills/flow-init/references/vision-templates.md +75 -75
- package/dist/skills/goal-development/SKILL.md +96 -96
- package/dist/skills/goal-migration/SKILL.md +114 -114
- package/dist/skills/goal-performance/SKILL.md +126 -0
- package/dist/skills/goal-research/SKILL.md +118 -118
- package/dist/skills/html-renderer/SKILL.md +173 -173
- package/dist/skills/html-renderer/references/index.html +318 -318
- package/dist/skills/html-renderer/references/styles.css +388 -388
- package/dist/skills/html-renderer/references/tokens.json +104 -104
- package/dist/skills/implementation-plan-executor/SKILL.md +378 -378
- package/dist/skills/implementation-verifier/SKILL.md +307 -307
- package/dist/skills/migration/SKILL.md +268 -268
- package/dist/skills/migration-analyze/SKILL.md +126 -126
- package/dist/skills/migration-finalize/SKILL.md +161 -161
- package/dist/skills/migration-fix/SKILL.md +155 -155
- package/dist/skills/migration-implement/SKILL.md +131 -131
- package/dist/skills/migration-plan/SKILL.md +131 -131
- package/dist/skills/migration-spec/SKILL.md +135 -135
- package/dist/skills/migration-spec/references/migration-strategies.md +430 -430
- package/dist/skills/migration-target/SKILL.md +134 -134
- package/dist/skills/migration-target/references/migration-types.md +489 -489
- package/dist/skills/migration-verify/SKILL.md +184 -184
- package/dist/skills/orchestrator-framework/SKILL.md +65 -65
- package/dist/skills/orchestrator-framework/references/command-namespacing.md +7 -7
- package/dist/skills/orchestrator-framework/references/confirm-or-revise-exception.md +20 -20
- package/dist/skills/orchestrator-framework/references/delegation-rules.md +54 -54
- package/dist/skills/orchestrator-framework/references/dispatcher-handoff.md +27 -27
- package/dist/skills/orchestrator-framework/references/fix-loop-contract.md +65 -65
- package/dist/skills/orchestrator-framework/references/gate-contract.md +122 -117
- package/dist/skills/orchestrator-framework/references/orchestrator-creation-checklist.md +51 -51
- package/dist/skills/orchestrator-framework/references/orchestrator-patterns.md +235 -235
- package/dist/skills/performance/SKILL.md +267 -437
- package/dist/skills/performance-analyze/SKILL.md +129 -0
- package/dist/skills/{performance → performance-analyze}/references/performance-optimization-guide.md +271 -365
- package/dist/skills/performance-finalize/SKILL.md +117 -0
- package/dist/skills/performance-implement/SKILL.md +114 -0
- package/dist/skills/performance-plan/SKILL.md +112 -0
- package/dist/skills/performance-spec/SKILL.md +145 -0
- package/dist/skills/performance-verify/SKILL.md +164 -0
- package/dist/skills/research/SKILL.md +249 -249
- package/dist/skills/research-brainstorm/SKILL.md +120 -120
- package/dist/skills/research-brainstorm/references/brainstorming-techniques.md +84 -84
- package/dist/skills/research-converge/SKILL.md +130 -130
- package/dist/skills/research-design/SKILL.md +146 -146
- package/dist/skills/research-design/references/design-techniques.md +40 -40
- package/dist/skills/research-finalize/SKILL.md +125 -125
- package/dist/skills/research-fork/SKILL.md +190 -190
- package/dist/skills/research-gather/SKILL.md +133 -133
- package/dist/skills/research-plan/SKILL.md +141 -141
- package/dist/skills/research-plan/references/research-methodologies.md +710 -710
- package/dist/skills/research-quick/SKILL.md +139 -139
- package/dist/skills/research-synthesize/SKILL.md +127 -127
- package/dist/skills/rule-reviewer/SKILL.md +334 -334
- package/dist/skills/standards-discover/SKILL.md +260 -260
- package/dist/skills/standards-discover/references/aggregation-strategy.md +76 -76
- package/dist/skills/standards-discover/references/code-pattern-prompt.md +68 -68
- package/dist/skills/standards-discover/references/config-analyzer-prompt.md +67 -67
- package/dist/skills/standards-discover/references/docs-extractor-prompt.md +65 -65
- package/dist/skills/standards-discover/references/external-analyzer-prompt.md +75 -75
- package/dist/skills/standards-update/SKILL.md +207 -207
- package/dist/templates/orchestrator-state-base.yml +17 -17
- package/dist/templates/orchestrator-state-development.yml +95 -95
- package/dist/templates/orchestrator-state-migration.yml +95 -95
- package/dist/templates/orchestrator-state-performance.yml +64 -53
- package/dist/templates/orchestrator-state-research.yml +67 -67
- package/dist/tools/fork_task.d.ts +17 -0
- package/dist/tools/fork_task.js +21 -11
- package/dist/tools/verify_template.d.ts +11 -0
- package/dist/tools/verify_template.js +32 -17
- package/dist/tui/hooks-dialogs.d.ts +20 -0
- package/dist/tui/hooks-dialogs.js +181 -0
- package/dist/tui/hooks-presenter.d.ts +15 -0
- package/dist/tui/hooks-presenter.js +70 -0
- package/dist/tui/hooks-sidebar.d.ts +10 -0
- package/dist/tui/hooks-sidebar.js +104 -0
- package/dist/tui/primitives.d.ts +21 -0
- package/dist/tui/primitives.js +47 -0
- package/dist/tui.d.ts +12 -0
- package/dist/tui.js +129 -0
- package/dist/types/hook-types.d.ts +125 -0
- package/dist/types/hook-types.js +76 -0
- package/dist/types/opencode-types.d.ts +13 -0
- package/dist/utils/file-util.d.ts +2 -0
- package/dist/utils/file-util.js +6 -6
- package/dist/utils/fork-task.d.ts +27 -0
- package/dist/utils/fork-task.js +18 -23
- package/dist/utils/plugin-info.d.ts +3 -0
- package/dist/utils/plugin-info.js +8 -10
- package/dist/utils/workflow-paths.d.ts +17 -0
- package/dist/utils/workflow-paths.js +18 -0
- package/dist/utils/yaml-structure.d.ts +7 -0
- package/dist/utils/yaml-structure.js +7 -11
- package/package.json +68 -48
- package/dist/hooks/before-tool.js +0 -19
|
@@ -1,28 +1,28 @@
|
|
|
1
|
-
## Components
|
|
2
|
-
|
|
3
|
-
### Single Responsibility
|
|
4
|
-
Each component should do one thing well.
|
|
5
|
-
|
|
6
|
-
### Reusability
|
|
7
|
-
Design components to work across different contexts with configurable props.
|
|
8
|
-
|
|
9
|
-
### Composability
|
|
10
|
-
Build complex UIs by combining smaller components rather than creating monoliths.
|
|
11
|
-
|
|
12
|
-
### Clear Interface
|
|
13
|
-
Define explicit, documented props with sensible defaults.
|
|
14
|
-
|
|
15
|
-
### Encapsulation
|
|
16
|
-
Keep implementation details private; expose only what's necessary.
|
|
17
|
-
|
|
18
|
-
### Consistent Naming
|
|
19
|
-
Use descriptive names that indicate purpose and follow team conventions.
|
|
20
|
-
|
|
21
|
-
### Local State
|
|
22
|
-
Keep state as close to where it's used as possible; lift only when needed.
|
|
23
|
-
|
|
24
|
-
### Minimal Props
|
|
25
|
-
If a component needs many props, consider composition or splitting it.
|
|
26
|
-
|
|
27
|
-
### Documentation
|
|
28
|
-
Document usage, props, and examples to help team adoption.
|
|
1
|
+
## Components
|
|
2
|
+
|
|
3
|
+
### Single Responsibility
|
|
4
|
+
Each component should do one thing well.
|
|
5
|
+
|
|
6
|
+
### Reusability
|
|
7
|
+
Design components to work across different contexts with configurable props.
|
|
8
|
+
|
|
9
|
+
### Composability
|
|
10
|
+
Build complex UIs by combining smaller components rather than creating monoliths.
|
|
11
|
+
|
|
12
|
+
### Clear Interface
|
|
13
|
+
Define explicit, documented props with sensible defaults.
|
|
14
|
+
|
|
15
|
+
### Encapsulation
|
|
16
|
+
Keep implementation details private; expose only what's necessary.
|
|
17
|
+
|
|
18
|
+
### Consistent Naming
|
|
19
|
+
Use descriptive names that indicate purpose and follow team conventions.
|
|
20
|
+
|
|
21
|
+
### Local State
|
|
22
|
+
Keep state as close to where it's used as possible; lift only when needed.
|
|
23
|
+
|
|
24
|
+
### Minimal Props
|
|
25
|
+
If a component needs many props, consider composition or splitting it.
|
|
26
|
+
|
|
27
|
+
### Documentation
|
|
28
|
+
Document usage, props, and examples to help team adoption.
|
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
## CSS
|
|
2
|
-
|
|
3
|
-
### Consistent Methodology
|
|
4
|
-
Stick to the project's chosen approach (Tailwind, BEM, CSS modules, etc.) across the entire codebase.
|
|
5
|
-
|
|
6
|
-
### Work With the Framework
|
|
7
|
-
Use framework patterns as intended rather than fighting them with excessive overrides.
|
|
8
|
-
|
|
9
|
-
### Design Tokens
|
|
10
|
-
Establish and document consistent values for colors, spacing, and typography.
|
|
11
|
-
|
|
12
|
-
### Minimize Custom CSS
|
|
13
|
-
Prefer framework utilities to reduce custom styling maintenance.
|
|
14
|
-
|
|
15
|
-
### Production Optimization
|
|
16
|
-
Use CSS purging or tree-shaking to remove unused styles.
|
|
1
|
+
## CSS
|
|
2
|
+
|
|
3
|
+
### Consistent Methodology
|
|
4
|
+
Stick to the project's chosen approach (Tailwind, BEM, CSS modules, etc.) across the entire codebase.
|
|
5
|
+
|
|
6
|
+
### Work With the Framework
|
|
7
|
+
Use framework patterns as intended rather than fighting them with excessive overrides.
|
|
8
|
+
|
|
9
|
+
### Design Tokens
|
|
10
|
+
Establish and document consistent values for colors, spacing, and typography.
|
|
11
|
+
|
|
12
|
+
### Minimize Custom CSS
|
|
13
|
+
Prefer framework utilities to reduce custom styling maintenance.
|
|
14
|
+
|
|
15
|
+
### Production Optimization
|
|
16
|
+
Use CSS purging or tree-shaking to remove unused styles.
|
|
@@ -1,28 +1,28 @@
|
|
|
1
|
-
## Responsive Design
|
|
2
|
-
|
|
3
|
-
### Mobile-First
|
|
4
|
-
Start with mobile layout and progressively enhance for larger screens.
|
|
5
|
-
|
|
6
|
-
### Standard Breakpoints
|
|
7
|
-
Use consistent breakpoints (mobile, tablet, desktop) across the application.
|
|
8
|
-
|
|
9
|
-
### Fluid Layouts
|
|
10
|
-
Use percentage-based widths and flexible containers that adapt to screen size.
|
|
11
|
-
|
|
12
|
-
### Relative Units
|
|
13
|
-
Prefer rem/em over fixed pixels for better scalability.
|
|
14
|
-
|
|
15
|
-
### Cross-Device Testing
|
|
16
|
-
Test across multiple screen sizes to ensure a balanced experience.
|
|
17
|
-
|
|
18
|
-
### Touch-Friendly
|
|
19
|
-
Size tap targets appropriately (minimum 44x44px) for mobile users.
|
|
20
|
-
|
|
21
|
-
### Mobile Performance
|
|
22
|
-
Optimize images and assets for mobile network conditions.
|
|
23
|
-
|
|
24
|
-
### Readable Typography
|
|
25
|
-
Maintain readable font sizes across all breakpoints.
|
|
26
|
-
|
|
27
|
-
### Content Priority
|
|
28
|
-
Show the most important content first on smaller screens.
|
|
1
|
+
## Responsive Design
|
|
2
|
+
|
|
3
|
+
### Mobile-First
|
|
4
|
+
Start with mobile layout and progressively enhance for larger screens.
|
|
5
|
+
|
|
6
|
+
### Standard Breakpoints
|
|
7
|
+
Use consistent breakpoints (mobile, tablet, desktop) across the application.
|
|
8
|
+
|
|
9
|
+
### Fluid Layouts
|
|
10
|
+
Use percentage-based widths and flexible containers that adapt to screen size.
|
|
11
|
+
|
|
12
|
+
### Relative Units
|
|
13
|
+
Prefer rem/em over fixed pixels for better scalability.
|
|
14
|
+
|
|
15
|
+
### Cross-Device Testing
|
|
16
|
+
Test across multiple screen sizes to ensure a balanced experience.
|
|
17
|
+
|
|
18
|
+
### Touch-Friendly
|
|
19
|
+
Size tap targets appropriately (minimum 44x44px) for mobile users.
|
|
20
|
+
|
|
21
|
+
### Mobile Performance
|
|
22
|
+
Optimize images and assets for mobile network conditions.
|
|
23
|
+
|
|
24
|
+
### Readable Typography
|
|
25
|
+
Maintain readable font sizes across all breakpoints.
|
|
26
|
+
|
|
27
|
+
### Content Priority
|
|
28
|
+
Show the most important content first on smaller screens.
|
|
@@ -1,25 +1,25 @@
|
|
|
1
|
-
## Coding Style
|
|
2
|
-
|
|
3
|
-
### Naming Consistency
|
|
4
|
-
Follow established naming patterns for variables, functions, classes, and files throughout the project.
|
|
5
|
-
|
|
6
|
-
### Automatic Formatting
|
|
7
|
-
Use automated tools to enforce consistent indentation, spacing, and line breaks.
|
|
8
|
-
|
|
9
|
-
### Descriptive Names
|
|
10
|
-
Choose names that clearly communicate intent; avoid cryptic abbreviations or single-letter identifiers outside tight loops.
|
|
11
|
-
|
|
12
|
-
### Focused Functions
|
|
13
|
-
Write functions that do one thing well; smaller functions are easier to read, test, and maintain.
|
|
14
|
-
|
|
15
|
-
### Uniform Indentation
|
|
16
|
-
Standardize on spaces or tabs and enforce with editor/linter settings.
|
|
17
|
-
|
|
18
|
-
### No Dead Code
|
|
19
|
-
Remove unused imports, commented-out blocks, and orphaned functions instead of leaving them behind.
|
|
20
|
-
|
|
21
|
-
### No Backward Compatibility Unless Required
|
|
22
|
-
Avoid extra code paths for backward compatibility unless explicitly needed.
|
|
23
|
-
|
|
24
|
-
### DRY (Don't Repeat Yourself)
|
|
25
|
-
Extract repeated logic into reusable functions or modules.
|
|
1
|
+
## Coding Style
|
|
2
|
+
|
|
3
|
+
### Naming Consistency
|
|
4
|
+
Follow established naming patterns for variables, functions, classes, and files throughout the project.
|
|
5
|
+
|
|
6
|
+
### Automatic Formatting
|
|
7
|
+
Use automated tools to enforce consistent indentation, spacing, and line breaks.
|
|
8
|
+
|
|
9
|
+
### Descriptive Names
|
|
10
|
+
Choose names that clearly communicate intent; avoid cryptic abbreviations or single-letter identifiers outside tight loops.
|
|
11
|
+
|
|
12
|
+
### Focused Functions
|
|
13
|
+
Write functions that do one thing well; smaller functions are easier to read, test, and maintain.
|
|
14
|
+
|
|
15
|
+
### Uniform Indentation
|
|
16
|
+
Standardize on spaces or tabs and enforce with editor/linter settings.
|
|
17
|
+
|
|
18
|
+
### No Dead Code
|
|
19
|
+
Remove unused imports, commented-out blocks, and orphaned functions instead of leaving them behind.
|
|
20
|
+
|
|
21
|
+
### No Backward Compatibility Unless Required
|
|
22
|
+
Avoid extra code paths for backward compatibility unless explicitly needed.
|
|
23
|
+
|
|
24
|
+
### DRY (Don't Repeat Yourself)
|
|
25
|
+
Extract repeated logic into reusable functions or modules.
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
## Commenting
|
|
2
|
-
|
|
3
|
-
### Let Code Speak
|
|
4
|
-
Write code that explains itself through structure and naming.
|
|
5
|
-
|
|
6
|
-
### Comment Sparingly
|
|
7
|
-
Add brief comments only when the logic isn't self-evident from the code.
|
|
8
|
-
|
|
9
|
-
### No Change Comments
|
|
10
|
-
Avoid comments about recent fixes or changes; comments should be timeless explanations, not changelogs.
|
|
1
|
+
## Commenting
|
|
2
|
+
|
|
3
|
+
### Let Code Speak
|
|
4
|
+
Write code that explains itself through structure and naming.
|
|
5
|
+
|
|
6
|
+
### Comment Sparingly
|
|
7
|
+
Add brief comments only when the logic isn't self-evident from the code.
|
|
8
|
+
|
|
9
|
+
### No Change Comments
|
|
10
|
+
Avoid comments about recent fixes or changes; comments should be timeless explanations, not changelogs.
|
|
@@ -1,31 +1,31 @@
|
|
|
1
|
-
## Development Conventions
|
|
2
|
-
|
|
3
|
-
### Predictable Structure
|
|
4
|
-
Organize files and directories in a logical, navigable layout.
|
|
5
|
-
|
|
6
|
-
### Up-to-Date Documentation
|
|
7
|
-
Keep README files current with setup steps, architecture overview, and contribution guidelines.
|
|
8
|
-
|
|
9
|
-
### Clean Version Control
|
|
10
|
-
Write clear commit messages, use feature branches, and add meaningful descriptions to pull requests.
|
|
11
|
-
|
|
12
|
-
### Environment Variables
|
|
13
|
-
Store configuration in environment variables; never commit secrets or API keys.
|
|
14
|
-
|
|
15
|
-
### Minimal Dependencies
|
|
16
|
-
Keep dependencies lean and up-to-date; document why major ones are included.
|
|
17
|
-
|
|
18
|
-
### Consistent Reviews
|
|
19
|
-
Follow a defined code review process with clear expectations for reviewers and authors.
|
|
20
|
-
|
|
21
|
-
### Testing Standards
|
|
22
|
-
Define required test coverage (unit, integration, etc.) before merging.
|
|
23
|
-
|
|
24
|
-
### Feature Flags
|
|
25
|
-
Use flags for incomplete features instead of long-lived branches.
|
|
26
|
-
|
|
27
|
-
### Changelog Updates
|
|
28
|
-
Maintain a changelog or release notes for significant changes.
|
|
29
|
-
|
|
30
|
-
### Build What's Needed
|
|
31
|
-
Avoid speculative code and "just in case" additions (see minimal-implementation.md).
|
|
1
|
+
## Development Conventions
|
|
2
|
+
|
|
3
|
+
### Predictable Structure
|
|
4
|
+
Organize files and directories in a logical, navigable layout.
|
|
5
|
+
|
|
6
|
+
### Up-to-Date Documentation
|
|
7
|
+
Keep README files current with setup steps, architecture overview, and contribution guidelines.
|
|
8
|
+
|
|
9
|
+
### Clean Version Control
|
|
10
|
+
Write clear commit messages, use feature branches, and add meaningful descriptions to pull requests.
|
|
11
|
+
|
|
12
|
+
### Environment Variables
|
|
13
|
+
Store configuration in environment variables; never commit secrets or API keys.
|
|
14
|
+
|
|
15
|
+
### Minimal Dependencies
|
|
16
|
+
Keep dependencies lean and up-to-date; document why major ones are included.
|
|
17
|
+
|
|
18
|
+
### Consistent Reviews
|
|
19
|
+
Follow a defined code review process with clear expectations for reviewers and authors.
|
|
20
|
+
|
|
21
|
+
### Testing Standards
|
|
22
|
+
Define required test coverage (unit, integration, etc.) before merging.
|
|
23
|
+
|
|
24
|
+
### Feature Flags
|
|
25
|
+
Use flags for incomplete features instead of long-lived branches.
|
|
26
|
+
|
|
27
|
+
### Changelog Updates
|
|
28
|
+
Maintain a changelog or release notes for significant changes.
|
|
29
|
+
|
|
30
|
+
### Build What's Needed
|
|
31
|
+
Avoid speculative code and "just in case" additions (see minimal-implementation.md).
|
|
@@ -1,22 +1,22 @@
|
|
|
1
|
-
## Error Handling
|
|
2
|
-
|
|
3
|
-
### Clear User Messages
|
|
4
|
-
Show helpful, actionable messages without exposing internal details or security-sensitive information.
|
|
5
|
-
|
|
6
|
-
### Fail Fast
|
|
7
|
-
Validate inputs and check preconditions early; reject invalid data before it causes deeper issues.
|
|
8
|
-
|
|
9
|
-
### Typed Exceptions
|
|
10
|
-
Use specific exception types instead of generic ones to enable precise error handling.
|
|
11
|
-
|
|
12
|
-
### Centralized Handling
|
|
13
|
-
Catch and process errors at appropriate boundaries (controllers, API layers) rather than scattering try-catch throughout.
|
|
14
|
-
|
|
15
|
-
### Graceful Degradation
|
|
16
|
-
When non-critical services fail, continue operating with reduced functionality rather than crashing entirely.
|
|
17
|
-
|
|
18
|
-
### Retry with Backoff
|
|
19
|
-
Use exponential backoff for transient failures when calling external services.
|
|
20
|
-
|
|
21
|
-
### Resource Cleanup
|
|
22
|
-
Always release resources (file handles, connections) in finally blocks or equivalent cleanup mechanisms.
|
|
1
|
+
## Error Handling
|
|
2
|
+
|
|
3
|
+
### Clear User Messages
|
|
4
|
+
Show helpful, actionable messages without exposing internal details or security-sensitive information.
|
|
5
|
+
|
|
6
|
+
### Fail Fast
|
|
7
|
+
Validate inputs and check preconditions early; reject invalid data before it causes deeper issues.
|
|
8
|
+
|
|
9
|
+
### Typed Exceptions
|
|
10
|
+
Use specific exception types instead of generic ones to enable precise error handling.
|
|
11
|
+
|
|
12
|
+
### Centralized Handling
|
|
13
|
+
Catch and process errors at appropriate boundaries (controllers, API layers) rather than scattering try-catch throughout.
|
|
14
|
+
|
|
15
|
+
### Graceful Degradation
|
|
16
|
+
When non-critical services fail, continue operating with reduced functionality rather than crashing entirely.
|
|
17
|
+
|
|
18
|
+
### Retry with Backoff
|
|
19
|
+
Use exponential backoff for transient failures when calling external services.
|
|
20
|
+
|
|
21
|
+
### Resource Cleanup
|
|
22
|
+
Always release resources (file handles, connections) in finally blocks or equivalent cleanup mechanisms.
|
|
@@ -1,22 +1,22 @@
|
|
|
1
|
-
## Minimal Implementation
|
|
2
|
-
|
|
3
|
-
### Build What You Need
|
|
4
|
-
Create only methods, classes, and functions that will actually be called.
|
|
5
|
-
|
|
6
|
-
### Clear Purpose
|
|
7
|
-
Every method should either be called or improve code readability; nothing else.
|
|
8
|
-
|
|
9
|
-
### Delete Exploration Artifacts
|
|
10
|
-
Remove helper methods and utilities created during development that ended up unused.
|
|
11
|
-
|
|
12
|
-
### No Future Stubs
|
|
13
|
-
Avoid empty methods, placeholder functions, or interfaces "for future extensibility".
|
|
14
|
-
|
|
15
|
-
### No Speculative Abstractions
|
|
16
|
-
Skip factories, strategies, or adapters unless there's an immediate need.
|
|
17
|
-
|
|
18
|
-
### Review Before Commit
|
|
19
|
-
Verify all new methods have callers or serve a clear readability purpose before completing a task.
|
|
20
|
-
|
|
21
|
-
### Unused Code Is Debt
|
|
22
|
-
Remove dead code promptly; it confuses readers and adds maintenance burden.
|
|
1
|
+
## Minimal Implementation
|
|
2
|
+
|
|
3
|
+
### Build What You Need
|
|
4
|
+
Create only methods, classes, and functions that will actually be called.
|
|
5
|
+
|
|
6
|
+
### Clear Purpose
|
|
7
|
+
Every method should either be called or improve code readability; nothing else.
|
|
8
|
+
|
|
9
|
+
### Delete Exploration Artifacts
|
|
10
|
+
Remove helper methods and utilities created during development that ended up unused.
|
|
11
|
+
|
|
12
|
+
### No Future Stubs
|
|
13
|
+
Avoid empty methods, placeholder functions, or interfaces "for future extensibility".
|
|
14
|
+
|
|
15
|
+
### No Speculative Abstractions
|
|
16
|
+
Skip factories, strategies, or adapters unless there's an immediate need.
|
|
17
|
+
|
|
18
|
+
### Review Before Commit
|
|
19
|
+
Verify all new methods have callers or serve a clear readability purpose before completing a task.
|
|
20
|
+
|
|
21
|
+
### Unused Code Is Debt
|
|
22
|
+
Remove dead code promptly; it confuses readers and adds maintenance burden.
|
|
@@ -1,28 +1,28 @@
|
|
|
1
|
-
## Validation
|
|
2
|
-
|
|
3
|
-
### Server-Side Always
|
|
4
|
-
Validate on the server; client-side validation alone is insufficient for security and data integrity.
|
|
5
|
-
|
|
6
|
-
### Client-Side for Feedback
|
|
7
|
-
Use client-side validation for immediate user feedback, but duplicate checks server-side.
|
|
8
|
-
|
|
9
|
-
### Validate Early
|
|
10
|
-
Check inputs as early as possible and reject invalid data before processing.
|
|
11
|
-
|
|
12
|
-
### Specific Errors
|
|
13
|
-
Provide clear, field-specific messages that help users correct their input.
|
|
14
|
-
|
|
15
|
-
### Allowlists Over Blocklists
|
|
16
|
-
Define what's allowed rather than trying to block everything else.
|
|
17
|
-
|
|
18
|
-
### Type and Format Checks
|
|
19
|
-
Validate data types, formats, ranges, and required fields systematically.
|
|
20
|
-
|
|
21
|
-
### Input Sanitization
|
|
22
|
-
Sanitize user input to prevent injection attacks (SQL, XSS, command injection).
|
|
23
|
-
|
|
24
|
-
### Business Rules
|
|
25
|
-
Validate business logic (sufficient balance, valid dates) at the appropriate layer.
|
|
26
|
-
|
|
27
|
-
### Consistent Enforcement
|
|
28
|
-
Apply validation uniformly across all entry points (forms, APIs, background jobs).
|
|
1
|
+
## Validation
|
|
2
|
+
|
|
3
|
+
### Server-Side Always
|
|
4
|
+
Validate on the server; client-side validation alone is insufficient for security and data integrity.
|
|
5
|
+
|
|
6
|
+
### Client-Side for Feedback
|
|
7
|
+
Use client-side validation for immediate user feedback, but duplicate checks server-side.
|
|
8
|
+
|
|
9
|
+
### Validate Early
|
|
10
|
+
Check inputs as early as possible and reject invalid data before processing.
|
|
11
|
+
|
|
12
|
+
### Specific Errors
|
|
13
|
+
Provide clear, field-specific messages that help users correct their input.
|
|
14
|
+
|
|
15
|
+
### Allowlists Over Blocklists
|
|
16
|
+
Define what's allowed rather than trying to block everything else.
|
|
17
|
+
|
|
18
|
+
### Type and Format Checks
|
|
19
|
+
Validate data types, formats, ranges, and required fields systematically.
|
|
20
|
+
|
|
21
|
+
### Input Sanitization
|
|
22
|
+
Sanitize user input to prevent injection attacks (SQL, XSS, command injection).
|
|
23
|
+
|
|
24
|
+
### Business Rules
|
|
25
|
+
Validate business logic (sufficient balance, valid dates) at the appropriate layer.
|
|
26
|
+
|
|
27
|
+
### Consistent Enforcement
|
|
28
|
+
Apply validation uniformly across all entry points (forms, APIs, background jobs).
|
|
@@ -1,25 +1,25 @@
|
|
|
1
|
-
## Test Writing
|
|
2
|
-
|
|
3
|
-
### Test Behavior
|
|
4
|
-
Focus on what code does, not how it does it, to allow safe refactoring.
|
|
5
|
-
|
|
6
|
-
### Clear Names
|
|
7
|
-
Use descriptive names explaining what's tested and expected (`shouldReturnErrorWhenUserNotFound`).
|
|
8
|
-
|
|
9
|
-
### Mock External Dependencies
|
|
10
|
-
Isolate tests by mocking databases, APIs, and external services.
|
|
11
|
-
|
|
12
|
-
### Fast Execution
|
|
13
|
-
Keep unit tests fast (milliseconds) so developers run them frequently.
|
|
14
|
-
|
|
15
|
-
### Risk-Based Testing
|
|
16
|
-
Prioritize testing based on business criticality and likelihood of bugs.
|
|
17
|
-
|
|
18
|
-
### Balance Coverage and Velocity
|
|
19
|
-
Adjust test coverage based on project needs and team workflow.
|
|
20
|
-
|
|
21
|
-
### Critical Path Focus
|
|
22
|
-
Ensure core user workflows and critical business logic are well-tested.
|
|
23
|
-
|
|
24
|
-
### Appropriate Depth
|
|
25
|
-
Match edge case testing to the risk profile of the code.
|
|
1
|
+
## Test Writing
|
|
2
|
+
|
|
3
|
+
### Test Behavior
|
|
4
|
+
Focus on what code does, not how it does it, to allow safe refactoring.
|
|
5
|
+
|
|
6
|
+
### Clear Names
|
|
7
|
+
Use descriptive names explaining what's tested and expected (`shouldReturnErrorWhenUserNotFound`).
|
|
8
|
+
|
|
9
|
+
### Mock External Dependencies
|
|
10
|
+
Isolate tests by mocking databases, APIs, and external services.
|
|
11
|
+
|
|
12
|
+
### Fast Execution
|
|
13
|
+
Keep unit tests fast (milliseconds) so developers run them frequently.
|
|
14
|
+
|
|
15
|
+
### Risk-Based Testing
|
|
16
|
+
Prioritize testing based on business criticality and likelihood of bugs.
|
|
17
|
+
|
|
18
|
+
### Balance Coverage and Velocity
|
|
19
|
+
Adjust test coverage based on project needs and team workflow.
|
|
20
|
+
|
|
21
|
+
### Critical Path Focus
|
|
22
|
+
Ensure core user workflows and critical business logic are well-tested.
|
|
23
|
+
|
|
24
|
+
### Appropriate Depth
|
|
25
|
+
Match edge case testing to the risk profile of the code.
|
|
@@ -1,29 +1,29 @@
|
|
|
1
|
-
# AGENTS.md Documentation Section Template
|
|
2
|
-
|
|
3
|
-
Add this section to the project's `AGENTS.md` file. Place it prominently near the top. Verify the INDEX.md path is correct and the file exists before adding.
|
|
4
|
-
|
|
5
|
-
```markdown
|
|
6
|
-
## Coding Standards & Conventions
|
|
7
|
-
|
|
8
|
-
Read @.owflow/docs/INDEX.md before starting any task. It indexes the project's coding standards and conventions:
|
|
9
|
-
|
|
10
|
-
- Coding standards organized by domain (frontend, backend, testing, etc.)
|
|
11
|
-
- Project vision, tech stack, and architecture decisions
|
|
12
|
-
|
|
13
|
-
Follow standards in `.owflow/docs/standards/` when writing code — they represent team decisions. If standards conflict with the task, ask the user.
|
|
14
|
-
|
|
15
|
-
### Standards Evolution
|
|
16
|
-
|
|
17
|
-
When you notice recurring patterns, fixes, or conventions during implementation that aren't yet captured in standards — suggest adding them. Examples:
|
|
18
|
-
|
|
19
|
-
- A bug fix reveals a pattern that should be standardized (e.g., "always validate X before Y")
|
|
20
|
-
- PR review feedback identifies a convention the team wants enforced
|
|
21
|
-
- The same type of fix is needed across multiple files
|
|
22
|
-
- A new library/pattern is adopted that should be documented
|
|
23
|
-
|
|
24
|
-
When this happens, briefly suggest the standard to the user. If approved, invoke `/owflow:standards-update` with the identified pattern.
|
|
25
|
-
|
|
26
|
-
## owflow Workflows
|
|
27
|
-
|
|
28
|
-
This project uses the owflow plugin for structured development workflows. When any `/*` command is invoked, execute it via the Skill tool immediately — do not skip workflows for "straightforward" tasks. The user chose the workflow intentionally; complexity assessment is the workflow's job.
|
|
29
|
-
```
|
|
1
|
+
# AGENTS.md Documentation Section Template
|
|
2
|
+
|
|
3
|
+
Add this section to the project's `AGENTS.md` file. Place it prominently near the top. Verify the INDEX.md path is correct and the file exists before adding.
|
|
4
|
+
|
|
5
|
+
```markdown
|
|
6
|
+
## Coding Standards & Conventions
|
|
7
|
+
|
|
8
|
+
Read @.owflow/docs/INDEX.md before starting any task. It indexes the project's coding standards and conventions:
|
|
9
|
+
|
|
10
|
+
- Coding standards organized by domain (frontend, backend, testing, etc.)
|
|
11
|
+
- Project vision, tech stack, and architecture decisions
|
|
12
|
+
|
|
13
|
+
Follow standards in `.owflow/docs/standards/` when writing code — they represent team decisions. If standards conflict with the task, ask the user.
|
|
14
|
+
|
|
15
|
+
### Standards Evolution
|
|
16
|
+
|
|
17
|
+
When you notice recurring patterns, fixes, or conventions during implementation that aren't yet captured in standards — suggest adding them. Examples:
|
|
18
|
+
|
|
19
|
+
- A bug fix reveals a pattern that should be standardized (e.g., "always validate X before Y")
|
|
20
|
+
- PR review feedback identifies a convention the team wants enforced
|
|
21
|
+
- The same type of fix is needed across multiple files
|
|
22
|
+
- A new library/pattern is adopted that should be documented
|
|
23
|
+
|
|
24
|
+
When this happens, briefly suggest the standard to the user. If approved, invoke `/owflow:standards-update` with the identified pattern.
|
|
25
|
+
|
|
26
|
+
## owflow Workflows
|
|
27
|
+
|
|
28
|
+
This project uses the owflow plugin for structured development workflows. When any `/*` command is invoked, execute it via the Skill tool immediately — do not skip workflows for "straightforward" tasks. The user chose the workflow intentionally; complexity assessment is the workflow's job.
|
|
29
|
+
```
|