@williambeto/ai-workflow 1.19.0 → 2.1.0

package/templates/README.template.md

@@ -1,293 +0,0 @@
-# [Project Name]
-
-[Short description of what this repository is and what problem it solves.]
-
-## Purpose
-
-[Explain the purpose of this repository.]
-
-This repository exists to:
-
-- [Goal 1]
-- [Goal 2]
-- [Goal 3]
-
-## Repository type
-
-[Application / library / documentation repository / starter kit / workflow repository / learning repository / internal tool]
-
-## Target users
-
-This repository is intended for:
-
-- [User type 1]
-- [User type 2]
-- [User type 3]
-
-## Tech stack
-
-| Area            | Technology                             |
-| --------------- | -------------------------------------- |
-| Language        | [Language]                             |
-| Framework       | [Framework]                            |
-| Package manager | [npm / pnpm / yarn / composer / other] |
-| Testing         | [Test tool]                            |
-| Build           | [Build tool]                           |
-| Deployment      | [Deployment platform or method]        |
-
-Use `Not applicable` for areas that do not apply.
-
-## Project status
-
-Current status:
-
-```txt
-Draft | Active development | Stable | Experimental | Deprecated
-```
-
-## Repository structure
-
-```txt
-[project-name]/
-├── [folder]/
-├── [folder]/
-├── [file]
-└── README.md
-```
-
-## Main folders
-
-### `[folder-name-1]/`
-
-[Explain what this folder contains and when it should be used.]
-
-### `[folder-name-2]/`
-
-[Explain what this folder contains and when it should be used.]
-
-### `[folder-name-3]/`
-
-[Explain what this folder contains and when it should be used.]
-
-## Getting started
-
-### Prerequisites
-
-- [Prerequisite 1]
-- [Prerequisite 2]
-- [Prerequisite 3]
-
-### Installation
-
-```bash
-[install command]
-```
-
-### Development
-
-```bash
-[development command]
-```
-
-### Build
-
-```bash
-[build command]
-```
-
-### Test
-
-```bash
-[test command]
-```
-
-Use `Not applicable` if this repository does not require runtime setup.
-
-## Environment variables
-
-Create a local environment file if required.
-
-```bash
-cp .env.example .env
-```
-
-| Variable        | Required | Description   |
-| --------------- | -------- | ------------- |
-| `VARIABLE_NAME` | Yes / No | [Description] |
-
-Do not commit real secrets.
-
-Use `Not applicable` if this repository does not use environment variables.
-
-## Workflow
-
-[Explain the main workflow used in this repository.]
-
-Recommended flow:
-
-1. [Step 1]
-2. [Step 2]
-3. [Step 3]
-4. [Step 4]
-
-## Development rules
-
-Contributors should follow these rules:
-
-- preserve existing behavior unless a behavior change is explicitly requested;
-- keep changes small and reviewable;
-- avoid unrelated refactors;
-- follow existing project patterns;
-- validate changes before marking them ready;
-- document assumptions and untested areas;
-- do not commit secrets or private credentials.
-
-## Documentation
-
-Important documentation files:
-
-| File        | Purpose                              |
-| ----------- | ------------------------------------ |
-| `AGENTS.md` | Rules for AI agents and contributors |
-| `DESIGN.md` | Visual design system and UI guidance |
-| `[file].md` | [Purpose]                            |
-
-Use `Not applicable` if the repository does not include these files.
-
-## Validation
-
-Before opening or approving a pull request, run the relevant checks.
-
-```bash
-[validation command]
-```
-
-Recommended validation checklist:
-
-- [ ] Formatting checked
-- [ ] Lint checked
-- [ ] Typecheck checked
-- [ ] Tests executed
-- [ ] Build executed
-- [ ] Manual validation completed
-- [ ] Regression risks reviewed
-- [ ] Untested areas documented
-
-Use only the checks relevant to the project.
-
-## Pull request workflow
-
-Each pull request should include:
-
-- clear objective;
-- controlled scope;
-- list of changed files;
-- validation evidence;
-- regression risks;
-- out-of-scope items;
-- final status.
-
-Avoid combining unrelated changes in the same pull request.
-
-## Deployment
-
-Deployment method:
-
-```txt
-[Manual / CI/CD / hosting platform / package publish / not applicable]
-```
-
-Before deployment, verify:
-
-- build passed;
-- required tests passed;
-- environment configuration is ready;
-- secrets are configured safely;
-- smoke tests are defined;
-- rollback or recovery path is known.
-
-Use `Not applicable` if this repository is not deployed.
-
-## Security
-
-Security rules:
-
-- do not commit secrets;
-- do not expose tokens, passwords, private keys, or credentials;
-- keep environment-specific values out of source control;
-- preserve authentication and authorization behavior;
-- validate user input when relevant;
-- avoid logging sensitive data.
-
-## Troubleshooting
-
-### [Problem 1]
-
-Symptoms:
-
-```txt
-[Describe symptoms]
-```
-
-Cause:
-
-```txt
-[Likely cause]
-```
-
-Fix:
-
-```bash
-[Fix command or steps]
-```
-
-### [Problem 2]
-
-Symptoms:
-
-```txt
-[Describe symptoms]
-```
-
-Cause:
-
-```txt
-[Likely cause]
-```
-
-Fix:
-
-```bash
-[Fix command or steps]
-```
-
-Use `Not applicable` if there are no known troubleshooting notes yet.
-
-## Out of scope
-
-This repository does not cover:
-
-- [Out-of-scope item 1]
-- [Out-of-scope item 2]
-- [Out-of-scope item 3]
-
-## Contributing
-
-Before contributing:
-
-1. read this `README.md`;
-2. read `AGENTS.md` if available;
-3. understand the current scope;
-4. create or review the relevant requirement/spec/technical plan when needed;
-5. keep the change small;
-6. validate before requesting review.
-
-## License
-
-[License name]
-
-Use `Not decided yet` if the license has not been chosen.
-
-## Notes
-
-[Any relevant project notes, assumptions, known limitations, or future improvements.]

package/templates/REQUIREMENT.template.md

@@ -1,165 +0,0 @@
-# Requirement
-
-## Title
-
-[Short, clear title for the requirement]
-
-## Status
-
-Draft | Ready for spec | Needs clarification | Too broad | Not recommended
-
-## Summary
-
-[Short explanation of the requirement in one or two sentences]
-
-## Problem
-
-[Describe the problem that needs to be solved]
-
-## Target user
-
-[Describe who is affected by this problem]
-
-Examples:
-
-- end user;
-- admin user;
-- developer;
-- maintainer;
-- support team;
-- business stakeholder.
-
-## Goal
-
-[Describe the expected outcome]
-
-The goal should explain what should improve after this requirement is delivered.
-
-## Current behavior
-
-[Describe what happens today]
-
-Use `Not applicable` if this is a new project or a new feature with no existing behavior.
-
-## Desired behavior
-
-[Describe what should happen after the requirement is implemented]
-
-## Scope
-
-### Included
-
-- [Item included in this requirement]
-- [Item included in this requirement]
-
-### Not included
-
-- [Item explicitly out of scope]
-- [Item explicitly out of scope]
-
-## Priority classification
-
-### Must-have
-
-Required for the requirement to be considered complete.
-
-- [Must-have item]
-
-### Should-have
-
-Important, but can be delayed if needed.
-
-- [Should-have item]
-
-### Could-have
-
-Useful, but not required for the first version.
-
-- [Could-have item]
-
-### Won't-have
-
-Explicitly out of scope for now.
-
-- [Won't-have item]
-
-## User story
-
-As a [type of user],  
-I want [capability],  
-so that [benefit].
-
-## Acceptance criteria
-
-### Scenario 1 — [Scenario name]
-
-Given [context],  
-when [action],  
-then [expected result].
-
-### Scenario 2 — [Scenario name]
-
-Given [context],  
-when [action],  
-then [expected result].
-
-## Business rules
-
-- [Business rule 1]
-- [Business rule 2]
-
-Use `Not applicable` if there are no known business rules.
-
-## Dependencies
-
-- [Dependency 1]
-- [Dependency 2]
-
-Use `None known` if there are no known dependencies.
-
-## Constraints
-
-- [Technical, business, legal, security, compatibility, design, or delivery constraint]
-
-Use `None known` if there are no known constraints.
-
-## Assumptions
-
-- [Assumption 1]
-- [Assumption 2]
-
-Assumptions must not be treated as confirmed facts.
-
-## Open questions
-
-- [Question 1]
-- [Question 2]
-
-Use `None` only when there are no relevant open questions.
-
-## Risks
-
-| Risk     | Impact   | Mitigation   |
-| -------- | -------- | ------------ |
-| [Risk 1] | [Impact] | [Mitigation] |
-| [Risk 2] | [Impact] | [Mitigation] |
-
-## Success metrics
-
-- [Metric 1]
-- [Metric 2]
-
-Use `Not applicable` if success metrics are not relevant for this requirement.
-
-## Out of scope
-
-- [Explicitly excluded item]
-- [Explicitly excluded item]
-
-## Notes
-
-[Any useful context, examples, screenshots, links, previous decisions, or related references]
-
-## Final recommendation
-
-Ready for spec | Needs clarification | Too broad | Not recommended