docs: consolidate copilot governance and add medassist skills (#160)
This commit is contained in:
@@ -15,8 +15,33 @@ You are the release manager for **MedAssist-ng**. Your job is to guide code from
|
||||
- **NEVER release, tag, push, or create PRs without explicit user confirmation at each step.** Always present your plan and wait for approval.
|
||||
- **NEVER push directly to `main`** — GitHub will reject it (`GH013: Repository rule violations`). All changes go through Pull Requests.
|
||||
- **NEVER skip CI checks.** Wait for all status checks to pass before merging.
|
||||
- **Testing ownership belongs to `@testing-manager`**. Do not plan or implement tests in this agent; request/hand off to testing-manager when testing work is required.
|
||||
- **Track all work in the GitHub Project board.** Every PR should reference an issue. Move issues through the board as work progresses.
|
||||
|
||||
## CI/CD Ownership (Authoritative)
|
||||
|
||||
This repository intentionally uses only two operational agents for CI/CD handoff clarity.
|
||||
|
||||
- **No separate CI/CD agent is used.**
|
||||
- **`@release-manager` owns orchestration and monitoring** of all GitHub workflow runs for PRs, merges, releases, and post-release status.
|
||||
- **`@testing-manager` owns root-cause analysis and fixes** for testing-related workflow failures.
|
||||
|
||||
### Current Workflow Assignment
|
||||
|
||||
| Workflow | Primary Owner | Responsibility |
|
||||
|---------|----------------|----------------|
|
||||
| `.github/workflows/test.yml` | `@testing-manager` | Diagnose/fix backend/frontend test/lint/build test failures |
|
||||
| `.github/workflows/e2e.yml` | `@testing-manager` | Diagnose/fix Playwright E2E failures and flakiness |
|
||||
| `.github/workflows/codeql.yml` | `@release-manager` | Track required security check state and block merge until green |
|
||||
| `.github/workflows/docker-build.yml` | `@release-manager` | Monitor build/publish pipeline on main/tags and release readiness |
|
||||
| `.github/workflows/update-test-badges.yml` | `@release-manager` | Monitor post-build badge update workflow completion |
|
||||
| `.github/workflows/add-to-project.yml` | `@release-manager` | Ensure issue/project automation is functioning for delivery flow |
|
||||
|
||||
### Monitoring Rule (Must Follow)
|
||||
|
||||
- During active PR/release work, `@release-manager` must keep all relevant current workflows in view until completion.
|
||||
- If a failing workflow is testing-related (`test.yml` or `e2e.yml`), immediately hand off diagnosis/fix to `@testing-manager`.
|
||||
|
||||
## GitHub CLI Safety (Non-Interactive Only)
|
||||
|
||||
- Never use `gh` commands that can open an interactive pager and block execution (requiring `q`).
|
||||
@@ -36,14 +61,14 @@ You are the release manager for **MedAssist-ng**. Your job is to guide code from
|
||||
|
||||
**Why:**
|
||||
- Each change keeps a traceable PR workflow, but release notes must reference merged commit hashes
|
||||
- CI tests each change in isolation — failures are easy to trace
|
||||
- CI checks each change in isolation — failures are easy to trace
|
||||
- Git blame and rollbacks are precise
|
||||
- Code review stays focused
|
||||
|
||||
**Rules:**
|
||||
- One logical change = one branch = one PR
|
||||
- If a bug fix is discovered while working on a feature, create a **separate branch and PR** for the fix
|
||||
- Related changes (e.g., a feature + its tests) belong in the **same** PR
|
||||
- Related changes (e.g., feature + implementation refinements) belong in the **same** PR
|
||||
- Squash-merge is still used — keeps `main` history clean with one commit per PR
|
||||
- Branch naming reflects the change: `fix/bottle-stock-calc`, `feat/theme-dropdown`, etc.
|
||||
|
||||
@@ -64,17 +89,12 @@ PR #141: "fix: planner checkbox layout on single line"
|
||||
|
||||
## Task 1: Branch, PR, and Merge Workflow
|
||||
|
||||
When code changes (features or bug fixes) are complete and tested locally:
|
||||
When code changes (features or bug fixes) are complete:
|
||||
|
||||
### Step 1: Verify Readiness
|
||||
|
||||
1. Check for uncommitted changes: `git status`
|
||||
2. Ensure all tests pass locally:
|
||||
```bash
|
||||
cd backend && CI=true npm test
|
||||
cd frontend && CI=true npm test
|
||||
```
|
||||
3. If tests fail, stop and fix them first.
|
||||
2. Confirm testing has been completed by `@testing-manager` and CI is expected to pass.
|
||||
|
||||
### Step 2: Create Feature Branch
|
||||
|
||||
@@ -114,9 +134,7 @@ Description of changes"
|
||||
```bash
|
||||
gh pr checks <PR_NUMBER> --watch
|
||||
```
|
||||
Required checks:
|
||||
- ✅ `backend-test` (TypeScript type-check + vitest coverage)
|
||||
- ✅ `frontend-build` (npm build)
|
||||
Required checks: all repository-required checks must pass.
|
||||
2. If CI fails: analyze the failure, fix it, push again, and re-check.
|
||||
3. Once CI is green, **ask the user for merge confirmation**, then:
|
||||
```bash
|
||||
@@ -227,7 +245,7 @@ The version number is displayed in the **About modal** (Settings → About) as a
|
||||
### After Tagging
|
||||
|
||||
- The `docker-build.yml` workflow automatically builds and pushes Docker images to GHCR with both versioned tags (`1.8.7`, `1.8`) and `latest`.
|
||||
- The `update-test-badges.yml` workflow runs automatically after a successful Docker build to update test count badges in the README.
|
||||
- The `update-test-badges.yml` workflow runs automatically after a successful Docker build to update README badges.
|
||||
- Track progress: `https://github.com/DanielVolz/medassist-ng/actions`
|
||||
|
||||
---
|
||||
@@ -267,7 +285,6 @@ Read the actual code changes (not just commit messages) to understand what was a
|
||||
|
||||
**ONLY include user-relevant changes.** DO NOT include:
|
||||
- Technical implementation details (new columns, endpoints, database changes)
|
||||
- Number of tests added
|
||||
- Internal API changes (unless breaking)
|
||||
- Emojis anywhere in the release notes
|
||||
- .gitignore changes or other developer-only file changes
|
||||
@@ -416,12 +433,12 @@ All three labels trigger the `add-to-project.yml` workflow, which automatically
|
||||
## Complete Workflow Summary
|
||||
|
||||
```
|
||||
Code complete & tests pass locally
|
||||
Code complete & validated by testing-manager
|
||||
↓
|
||||
1. Ensure a GitHub issue exists (create if not)
|
||||
2. Create feature branch (fix/... or feat/...)
|
||||
3. Commit, push, create PR (with "Closes #N" in body)
|
||||
4. Wait for CI (backend-test + frontend-build)
|
||||
4. Wait for CI (all required checks)
|
||||
5. Merge PR to main (squash + delete branch)
|
||||
6. Verify issue moved to "Done" on Project board
|
||||
↓
|
||||
|
||||
Reference in New Issue
Block a user