Skip to content

docs(harness): document workflow gates#263

Closed
egdev6 wants to merge 2 commits into
mainfrom
docs/261-harness-gates
Closed

docs(harness): document workflow gates#263
egdev6 wants to merge 2 commits into
mainfrom
docs/261-harness-gates

Conversation

@egdev6
Copy link
Copy Markdown
Member

@egdev6 egdev6 commented Jun 5, 2026

Summary

Document the harness gates added for linked issues, Storybook stories, and paired bilingual docs.

Closes #261

Review scope

  • Primary files/areas:
    • .atl/skills/* harness rules for issue START WORK, PR readiness, component/spec flow, worktree flow, Storybook stories, component audit, and bilingual docs review.
    • .atl/AGENTS.md and contributor docs language rule.
    • .github/ISSUE_TEMPLATE/*.yml and .github/PULL_REQUEST_TEMPLATE.md workflow checklists.
    • Contributor docs and README/quick-start/environment setup docs.
    • docs/COMPONENTS.md restored as the Spanish pair for docs/COMPONENTS.en.md.
  • Out of scope:
    • Component runtime behavior.
    • Existing local/unrelated .gitignore, .atl/skill-registry.md, reviews/, and sdd-init-result.md changes.
  • Review workload: medium; docs-only harness alignment across duplicated contributor surfaces.

Type of change

  • New component
  • Existing component update/refactor
  • Bug fix
  • Accessibility
  • Design tokens
  • Storybook/docs
  • Infrastructure/tooling
  • NPM/dependencies

Workflow gates

  • Linked issue is present with Closes #NNN or maintainer approved an exception.
  • Linked issue has label status:approved before implementation starts.
  • Linked issue assignee was checked before work started; issue was unassigned, then assigned to @egdev6.
  • Work was started through the Project flow: assignee set, Project status In progress, branch/worktree recorded.
  • PR title follows Conventional Commit format: <type>(<optional scope>): <description>.
  • Commits follow the same commitlint-enforced format.
  • Diff is focused; unrelated work is called out in Review scope.
  • MCP/runtime artifacts are absent: .playwright-mcp, page-*.png, page-*.jpeg, *.md.playwright-output.

Component evidence (required for component changes)

N/A — docs/harness-only change.

Accessibility evidence

N/A — docs/harness-only change.

Validation evidence

  • TypeScript: lefthook pre-commit ran typecheck during both commits — passed.
  • Unit tests: lefthook pre-push ran pnpm test — 32 files / 608 tests passed after each push.
  • Build/package: not run locally; docs/harness-only change.
  • Storybook or visual check: not run locally; no component visuals changed.
  • Accessibility check: not run locally; no runtime accessibility changed.
  • Security/dependency check: not run locally; no dependency changes.
  • Diff hygiene: git diff --check passed.
  • Bilingual docs check: docs/COMPONENTS.md is Spanish; fenced code blocks match docs/COMPONENTS.en.md exactly (95/95).
  • Review: fresh reviewer confirmed prior blockers resolved and bilingual-doc follow-up has no blockers.

Screenshots or recordings

N/A — docs/harness-only change.

Notes for reviewer

This PR codifies three harness rules:

  1. Linked issue guard: before actions from a linked issue, verify assignees; if assigned to someone else, stop and require explicit permission before reassignment/takeover.
  2. Storybook story guard: avoid redundant stories, use Storybook's global dark-mode toolbar for normal theme coverage, and require useful per-story JSDoc explaining the scenario and why it matters.
  3. Bilingual docs guard: paired root/docs files keep Spanish in base *.md and English in matching .en.md; Storybook/code/comments/identifiers remain English.

@egdev6 egdev6 added the type:docs Documentation changes label Jun 5, 2026
@egdev6 egdev6 marked this pull request as ready for review June 5, 2026 17:48
@egdev6 egdev6 mentioned this pull request Jun 5, 2026
16 tasks
@egdev6
Copy link
Copy Markdown
Member Author

egdev6 commented Jun 5, 2026

Superseded by #264. This PR was created while recovering the branch after #262 merged and still shows the broad pre-merge diff; #264 contains the focused bilingual-docs follow-up only.

@egdev6
Copy link
Copy Markdown
Member Author

egdev6 commented Jun 5, 2026

Closing in favor of focused follow-up #264.

@egdev6 egdev6 closed this Jun 5, 2026
@egdev6 egdev6 deleted the docs/261-harness-gates branch June 5, 2026 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:docs Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(harness): document issue and Storybook harness gates

1 participant