Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions .github/instructions/ALIGN-INSTRUCTIONS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Aligned Instructions

This directory contains instruction files used to guide AI agents and developers on project standards, workflows, and best practices.

## File Manifest & Changes

### Core Technology Stack

* **`nodejs-javascript-vitest.instructions.md`**
* **Purpose**: Guidelines for Node.js and JavaScript code, specifically focusing on Vitest for testing.
* **Changes**:
* Updated package manager from `npm` to `pnpm`.
* Removed legacy reference to "SpaceAutoBattler".
* Ensured alignment with `package.json` (Node 20+).

* **`typescript-5-es2022.instructions.md`**
* **Purpose**: Best practices for TypeScript 5.x development targeting ES2022.
* **Changes**:
* Updated lint command to use `pnpm lint`.

* **`reactjs.instructions.md`**
* **Purpose**: Standards for React application development (hooks, functional components, architecture).
* **Changes**:
* Verified alignment with current best practices (React 19+, functional components).

* **`playwright-typescript.instructions.md`**
* **Purpose**: Guidelines for writing E2E tests with Playwright.
* **Changes**:
* Removed duplicate/malformed content at the end of the file.
* Updated example code to refer to generic paths or correct ports (aligned with `playwright.config.ts`).

### Workflows & Processes

* **`memory-bank.instructions.md`**
* **Purpose**: definitive guide for the Memory Bank system (`/memory/`), including task tracking and context management.
* **Changes**: None required (served as the source of truth).

* **`spec-driven-workflow-v1.instructions.md`**
* **Purpose**: A 6-phase workflow (Analyze -> Design -> Implement -> Validate -> Reflect -> Handoff).
* **Changes**:
* Heavily refactored to remove duplicate sections.
* Aligned file paths with the Memory Bank structure (`memory/tasks/` instead of root `tasks.md`).
* Consolidated checklists for clarity.

### Documentation & Best Practices

* **`code-review-generic.instructions.md`**: General code review checklist.
* **`github-actions-ci-cd-best-practices.instructions.md`**: Best practices for CI/CD workflows.
* **`markdown.instructions.md`**: Style guide for Markdown files.
* **`performance-optimization.instructions.md`**: General performance tips.
* **`self-explanatory-code-commenting.instructions.md`**: Philosophy on code comments.
* **`ai-prompt-engineering-safety-best-practices.instructions.md`**: AI interaction guidelines.
* **`prompt.instructions.md`**: General prompt guidelines.
* **`taming-copilot.instructions.md`**: Specifics for interacting with Copilot.

### Removed / Archived

* **`powershell.instructions.md`**: Deleted. Irrelevant for this specific web/tech stack.
* **`tasksync.instructions.md`**: Deleted. Legacy/External tool configuration not relevant to the current repository structure.

## Summary of Global Alignments

1. **Package Manager**: Standardized on `pnpm` across all instructions and `AGENTS.md`.
2. **Paths**: Aligned all references to task management to point to `memory/tasks/`.
3. **Cleanup**: Removed irrelevant files and fixed malformed content.
4 changes: 2 additions & 2 deletions .github/instructions/nodejs-javascript-vitest.instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Checklist:
- [ ] All state via canonical GameState if simulation
- [ ] Tests: happy path + edge

Repo notes (SpaceAutoBattler):
Repo notes:

- Run `npm run typecheck` and `npm test` after edits; CI enforces these gates. Avoid changing files outside `src/` (no edits to `dist/`).
- Run `pnpm typecheck` and `pnpm test` after edits; CI enforces these gates. Avoid changing files outside `src/` (no edits to `dist/`).

End.
36 changes: 21 additions & 15 deletions .github/instructions/playwright-typescript.instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,17 @@ description: 'Playwright test generation instructions'
applyTo: '**'
---

# Playwright (TypeScript) — Short Guide

Receipt: "Write resilient Playwright tests."

Plan: 1) Use role-based locators. 2) Use auto-retrying assertions. 3) No hard waits.

Checklist:
- [ ] Role-based locators
- [ ] All state via canonical GameState if simulation
- [ ] Clear test titles and steps

## Test Writing Guidelines

### Code Quality Standards
Expand Down Expand Up @@ -40,27 +51,22 @@ import { test, expect } from '@playwright/test';
test.describe('Movie Search Feature', () => {
test.beforeEach(async ({ page }) => {
// Navigate to the application before each test
await page.goto('https://debs-obrien.github.io/playwright-movies-app');
// Note: use the URL from playwright.config.ts (usually / or http://localhost:5173 or 5174)
await page.goto('/');
});

test('Search for a movie by title', async ({ page }) => {
await test.step('Activate and perform search', async () => {
await page.getByRole('search').click();
const searchInput = page.getByRole('textbox', { name: 'Search Input' });
await searchInput.fill('Garfield');
await page.goto('http://localhost:8080/');

# Playwright (TypeScript) — Short Guide

Receipt: "Write resilient Playwright tests."

Plan: 1) Use role-based locators. 2) Use auto-retrying assertions. 3) No hard waits.

Checklist:
- [ ] Role-based locators
- [ ] All state via canonical GameState if simulation
- [ ] Clear test titles and steps

End.
});

await test.step('Verify results', async () => {
// ... assertions
});
});
});
```

End.
18 changes: 0 additions & 18 deletions .github/instructions/powershell.instructions.md

This file was deleted.

Loading
Loading