diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 19d8762..c38f32b 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -5,10 +5,19 @@ body: - type: textarea id: problem attributes: - label: Problem or motivation + label: User problem + description: Who is affected, and what are they unable to do today? validations: required: true - type: textarea - id: solution + id: outcome attributes: - label: Proposed solution + label: Desired outcome and acceptance criteria + description: Describe the observable result that would solve the problem. List testable acceptance criteria. + validations: + required: true + - type: textarea + id: constraints + attributes: + label: Constraints or non-goals + description: Note important limitations or work that should stay out of scope. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..51c3309 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,18 @@ +## Outcome + +What user or project outcome does this change deliver? + +## Changes + +Summarize the implementation and any relevant trade-offs. + +## Verification + +- [ ] Tests cover the expected behavior +- [ ] `npm run lint` +- [ ] `npm test -- --watch=false` +- [ ] `npm run build` + +## Follow-up + +List any known gaps or follow-up work, or write "None". diff --git a/.github/workflows/verify.yml b/.github/workflows/verify.yml new file mode 100644 index 0000000..edc6b84 --- /dev/null +++ b/.github/workflows/verify.yml @@ -0,0 +1,39 @@ +name: Verify + +on: + pull_request: + push: + branches: + - main + +permissions: + contents: read + +concurrency: + group: verify-${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + verify: + runs-on: ubuntu-latest + steps: + - name: Check out repository + uses: actions/checkout@v4 + + - name: Set up Node.js + uses: actions/setup-node@v4 + with: + node-version: 22 + cache: npm + + - name: Install dependencies + run: npm ci + + - name: Lint + run: npm run lint + + - name: Test + run: npm test -- --watch=false + + - name: Build + run: npm run build diff --git a/README.md b/README.md index 54b61d0..18d0d5f 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,16 @@ ng e2e Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs. +## Delivery workflow + +Keep work outcome-led and specifications lightweight: + +- Open an issue when work needs coordination. Describe the user problem, the observable outcome, and testable acceptance criteria; include constraints or non-goals when they matter. +- Keep implementation detail in the code and tests. Update the issue or documentation when the expected behavior changes. +- Use a pull request to explain the outcome, implementation trade-offs, and verification. Keep review focused on correctness and user impact rather than ceremony or status reporting. +- Pull requests and pushes to `main` run lint, unit tests, and a production build through the **Verify** workflow. Merge after those checks pass and review is complete. +- Ship when the change is ready; this repository does not currently configure automated deployment. + ## Additional Resources For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.