diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..5b5c3f7 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,17 @@ +## Summary + +- + +## What Changed + +- + +## Verification + +- + +## Checklist + +- [ ] Links in `README.md` work +- [ ] `npx -y markdownlint-cli2 "**/*.md" "#node_modules"` passes +- [ ] `npx -y awesome-lint` passes diff --git a/README.md b/README.md index fa63ea2..8e9b4ec 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ A curated list of instructions, prompts, skills, MCPs, and custom agent markdown - [Instructions](#instructions) - [Boilerplates \& Templates](#boilerplates--templates) - [Languages \& Stacks](#languages--stacks) + - [Frameworks \& Libraries](#frameworks--libraries) + - [Tools](#tools) - [Workflows](#workflows) - [Prompts](#prompts) - [Custom Agents](#custom-agents) @@ -32,15 +34,41 @@ Instructions provide Copilot with repository-specific context to improve suggest ### Boilerplates \& Templates - [Standard Language Template](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/boilerplate-and-templates/standard-language.instructions.md) - A minimal template for new instruction files. +- [Standard IaC Tools Boilerplate](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/boilerplate-and-templates/standard-iac-tools.instructions.md) - Boilerplate for infrastructure-as-code repos. ### Languages \& Stacks +- [C (Standard Focus)](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/languages/c/c.instructions.md) - System utilities and libraries. +- [C# (Standard Focus)](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/languages/csharp/csharp.instructions.md) - Modern .NET applications. +- [C++ (Standard Focus)](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/languages/cplusplus/cplusplus.instructions.md) - Modern C++ patterns and performance. +- [Go (Standard Focus)](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/languages/go/go.instructions.md) - Services and CLIs. +- [Java (Standard Focus)](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/languages/java/java.instructions.md) - Backend services. - [JavaScript (Standard Focus)](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/languages/javascript/javascript.instructions.md) - Modern JS for Node.js and browsers. +- [Kotlin (Standard Focus)](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/languages/kotlin/kotlin.instructions.md) - Android and JVM services. +- [Lua (Standard Focus)](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/languages/lua/lua.instructions.md) - Scripting and automation. +- [Python (Standard Focus)](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/languages/python/python.instructions.md) - Services, scripts, and libraries. +- [Rust (Standard Focus)](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/languages/rust/rust.instructions.md) - Safe systems programming. +- [Swift (Standard Focus)](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/languages/swift/swift.instructions.md) - iOS/macOS apps. - [TypeScript (Standard Focus)](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/languages/typescript/typescript.instructions.md) - TS in React/Node with strictness and ergonomic patterns. +### Frameworks \& Libraries + +- [Charmbracelet + Cobra CLI (Go)](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/frameworks/cobra-cli-go/charmbracelet-cli.instructions.md) - Build interactive CLIs. +- [Express API (Node.js + TypeScript)](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/frameworks/nodejs-typescript/express-api.instructions.md) - REST APIs with Express. +- [Next.js (React)](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/frameworks/react/nextjs.instructions.md) - Next.js app conventions. + +### Tools + +- [Docker](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/tools/docker/docker.instructions.md) - Containerization guidance. +- [GitHub Actions](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/tools/github-actions/github-actions.instructions.md) - Workflow conventions. +- [Terraform](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/tools/infra-as-code/terraform/terraform.instructions.md) - IaC conventions and safety. +- [Playwright](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/tools/testing/playwright/playwright.instructions.md) - Browser test stability. + ### Workflows +- [Code Review](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/workflows/code-review.instructions.md) - Review for correctness, security, and regressions. - [PRD Creation](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/workflows/ai-development-instructions/prd-creation.instructions.md) - Create a Product Requirements Document. +- [Release](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/workflows/release.instructions.md) - Prepare releases and notes. - [Task Generation](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/workflows/ai-development-instructions/task-generation.instructions.md) - Break a PRD into actionable tasks. - [Task Execution](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/instructions/workflows/ai-development-instructions/task-execution.instructions.md) - Execute tasks with testing and Git hygiene. @@ -51,6 +79,9 @@ Prompts are reusable task definitions that guide Copilot to produce a specific o - [PRD Creation Prompt](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/prompts/ai-development-tasks/prd-creation.prompt.md) - Create a PRD from a feature idea. - [Task Generation Prompt](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/prompts/ai-development-tasks/task-generation.prompt.md) - Turn a PRD into a task list. - [Task Execution Prompt](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/prompts/ai-development-tasks/task-execution.prompt.md) - Execute a single task safely. +- [Bug Triage Prompt](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/prompts/debugging/bug-triage.prompt.md) - Triage a bug report into next steps. +- [Code Review Prompt](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/prompts/code-review/review-changes.prompt.md) - Review a diff/PR for risks. +- [README Writing Prompt](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/prompts/documentation/write-readme.prompt.md) - Draft or improve a README. ## Custom Agents @@ -60,12 +91,19 @@ Custom agents let you define specialized Copilot personas (planner, architect, d - [Clean Code](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/agents/ai-development-mode/clean-code.agent.md) - Improve readability and maintainability. - [Debugger](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/agents/ai-development-mode/debugger.agent.md) - Diagnose and fix bugs. - [PRD Creation](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/agents/ai-development-mode/prd-creation.agent.md) - Produce PRDs from rough ideas. +- [Documentation Writer](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/agents/review-and-quality/documentation.agent.md) - Improve docs and onboarding. +- [Performance Engineer](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/agents/review-and-quality/performance.agent.md) - Identify performance bottlenecks. +- [Security Reviewer](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/agents/review-and-quality/security-reviewer.agent.md) - Review for security risks. +- [Release Manager](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/agents/release/release-manager.agent.md) - Prepare releases and changelogs. ## Agent Skills Agent Skills are portable, version-controlled folders of instructions and resources that agents can load on demand. - [Calculator](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/skills/calculator/SKILL.md) - Perform precise arithmetic and conversions. +- [Git CLI](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/skills/git-cli/SKILL.md) - Safe Git workflows and troubleshooting. +- [Issue Triage](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/skills/issue-triage/SKILL.md) - Turn bug reports into actionable work. +- [Markdown Editor](https://github.com/ReactSphere/awesome-copilot-agents/tree/main/skills/markdown-editor/SKILL.md) - Maintain lint-friendly markdown. ## MCPs diff --git a/agents/release/release-manager.agent.md b/agents/release/release-manager.agent.md new file mode 100644 index 0000000..511e55b --- /dev/null +++ b/agents/release/release-manager.agent.md @@ -0,0 +1,14 @@ +--- +description: Prepare releases and changelogs. +mode: agent +--- + +# Release Manager + +You help prepare releases. + +## Output + +- Version recommendation +- Release notes draft +- Risk checklist diff --git a/agents/review-and-quality/documentation.agent.md b/agents/review-and-quality/documentation.agent.md new file mode 100644 index 0000000..d6c0a42 --- /dev/null +++ b/agents/review-and-quality/documentation.agent.md @@ -0,0 +1,15 @@ +--- +description: Improve docs for clarity, correctness, and onboarding. +mode: agent +--- + +# Documentation Writer + +You improve documentation quality and developer onboarding. + +## Focus + +- Clear examples +- Correct commands +- Troubleshooting tips +- Avoiding outdated guidance diff --git a/agents/review-and-quality/performance.agent.md b/agents/review-and-quality/performance.agent.md new file mode 100644 index 0000000..ce969b7 --- /dev/null +++ b/agents/review-and-quality/performance.agent.md @@ -0,0 +1,20 @@ +--- +description: Identify performance bottlenecks and propose practical fixes. +mode: agent +--- + +# Performance Engineer + +You focus on runtime performance, memory, and responsiveness. + +## Rules + +- Prefer measuring before optimizing. +- Call out algorithmic complexity. +- Avoid micro-optimizations that reduce clarity. + +## Output + +- Bottlenecks and why they matter +- Minimal improvements +- How to measure impact diff --git a/agents/review-and-quality/security-reviewer.agent.md b/agents/review-and-quality/security-reviewer.agent.md new file mode 100644 index 0000000..c9f1b13 --- /dev/null +++ b/agents/review-and-quality/security-reviewer.agent.md @@ -0,0 +1,22 @@ +--- +description: Review changes for security risks and safe-by-default patterns. +mode: agent +--- + +# Security Reviewer + +You review code and configuration for security issues. + +## Focus Areas + +- Secrets handling +- Authn/Authz correctness +- Injection risks (SQL, command, template) +- SSRF, path traversal, deserialization +- Dependency and supply-chain concerns + +## Output + +- Findings ordered by severity +- Concrete mitigation suggestions +- Suggested tests or checks diff --git a/instructions/boilerplate-and-templates/standard-iac-tools.instructions.md b/instructions/boilerplate-and-templates/standard-iac-tools.instructions.md new file mode 100644 index 0000000..2502711 --- /dev/null +++ b/instructions/boilerplate-and-templates/standard-iac-tools.instructions.md @@ -0,0 +1,30 @@ +--- +description: Boilerplate instructions for Infrastructure-as-Code repositories. +applyTo: "**/*.{tf,tfvars,tmpl,yaml,yml,json,sh,ps1}" +--- + +# Standard IaC Tools Instructions + +Use these rules when generating or editing IaC code. + +## General + +- Prefer small, composable modules over monolith templates. +- Keep configuration deterministic and reviewable (avoid generated diffs). +- Treat secrets as out-of-repo. Never inline credentials in code. + +## Naming + +- Use consistent resource naming (prefix, environment, region). +- Avoid abbreviations unless they are already standard in the org. + +## Safety + +- Default to least privilege for IAM policies and roles. +- Avoid destructive operations unless explicitly requested. +- If a change can cause downtime, call it out and propose a rollout plan. + +## Documentation + +- Document module inputs/outputs. +- Add examples for non-obvious usage. diff --git a/instructions/frameworks/cobra-cli-go/charmbracelet-cli.instructions.md b/instructions/frameworks/cobra-cli-go/charmbracelet-cli.instructions.md new file mode 100644 index 0000000..e483f0e --- /dev/null +++ b/instructions/frameworks/cobra-cli-go/charmbracelet-cli.instructions.md @@ -0,0 +1,26 @@ +--- +description: Instructions for Cobra-based CLIs with Charmbracelet UI. +applyTo: "**/*.go" +--- + +# Charmbracelet + Cobra CLI Instructions + +## UX + +- Commands should have clear `Use`, `Short`, and `Long` descriptions. +- Provide examples in help text for non-trivial flags. + +## Flags + +- Prefer explicit flags over positional arguments. +- Use consistent names across commands. + +## Errors + +- Return actionable errors (what failed, how to fix). +- Use non-zero exit codes on failure. + +## TUI + +- Keep render loops deterministic. +- Avoid blocking IO in the UI update loop. diff --git a/instructions/frameworks/nodejs-typescript/express-api.instructions.md b/instructions/frameworks/nodejs-typescript/express-api.instructions.md new file mode 100644 index 0000000..2a2e38c --- /dev/null +++ b/instructions/frameworks/nodejs-typescript/express-api.instructions.md @@ -0,0 +1,33 @@ +--- +description: Instructions for building Express REST APIs with TypeScript. +applyTo: "**/*.{ts,tsx}" +--- + +# Express API (TypeScript) Instructions + +## API Design + +- Use consistent error shapes (status, code, message, details). +- Validate inputs at the boundary (params, query, body). +- Prefer explicit HTTP status codes. + +## Structure + +- Keep routing thin; put business logic in services. +- Keep DB access behind repositories/adapters. +- Avoid global mutable state. + +## TypeScript + +- Avoid `any`. +- Use `zod`/`yup` style schemas if already present; otherwise use minimal runtime checks. + +## Observability + +- Log request id / correlation id when available. +- Do not log secrets or full request bodies for auth endpoints. + +## Testing + +- Add request-level tests for new endpoints. +- Cover auth/permission edge cases. diff --git a/instructions/frameworks/react/nextjs.instructions.md b/instructions/frameworks/react/nextjs.instructions.md new file mode 100644 index 0000000..83bd53e --- /dev/null +++ b/instructions/frameworks/react/nextjs.instructions.md @@ -0,0 +1,26 @@ +--- +description: Instructions for Next.js (React) applications. +applyTo: "**/*.{ts,tsx,js,jsx}" +--- + +# Next.js Instructions + +## Routing + +- Prefer file-based routing conventions. +- Keep server-only code out of client components. + +## Data Fetching + +- Prefer server components for data loading when possible. +- Use caching intentionally; call out revalidation settings. + +## UI + +- Keep components small and accessible. +- Avoid layout shift; size images and reserve space. + +## Performance + +- Avoid shipping large libraries to the client unless necessary. +- Prefer dynamic import for heavy optional UI. diff --git a/instructions/languages/c/c.instructions.md b/instructions/languages/c/c.instructions.md new file mode 100644 index 0000000..76fa494 --- /dev/null +++ b/instructions/languages/c/c.instructions.md @@ -0,0 +1,26 @@ +--- +description: C standards for system utilities and libraries. +applyTo: "**/*.{c,h}" +--- + +# C Instructions + +## Portability + +- Prefer standard C (C11+) and POSIX where appropriate. +- Avoid compiler-specific extensions unless required. + +## Memory Safety + +- Initialize variables. +- Check allocation and IO return codes. +- Avoid unchecked `strcpy`, `sprintf`. + +## Style + +- Keep functions small. +- Prefer explicit error handling paths. + +## Testing + +- Add unit tests for parsing and boundary conditions when feasible. diff --git a/instructions/languages/cplusplus/cplusplus.instructions.md b/instructions/languages/cplusplus/cplusplus.instructions.md new file mode 100644 index 0000000..7053dfe --- /dev/null +++ b/instructions/languages/cplusplus/cplusplus.instructions.md @@ -0,0 +1,22 @@ +--- +description: Modern C++ standards for performance-sensitive code. +applyTo: "**/*.{cc,cpp,cxx,h,hpp,hxx}" +--- + +# C++ Instructions + +## Modern C++ + +- Prefer RAII for resource management. +- Prefer `std::unique_ptr` / `std::shared_ptr` over raw owning pointers. +- Prefer `std::string_view` for non-owning string parameters. + +## Safety + +- Avoid undefined behavior. +- Prefer bounds-checked access for untrusted inputs. + +## Performance + +- Avoid unnecessary allocations. +- Measure before optimizing. diff --git a/instructions/languages/csharp/csharp.instructions.md b/instructions/languages/csharp/csharp.instructions.md new file mode 100644 index 0000000..66ad2e6 --- /dev/null +++ b/instructions/languages/csharp/csharp.instructions.md @@ -0,0 +1,27 @@ +--- +description: C# standards for modern .NET applications. +applyTo: "**/*.{cs,csx}" +--- + +# C# Instructions + +## Language + +- Use nullable reference types. +- Prefer records for immutable data. +- Prefer `async`/`await` over blocking calls. + +## APIs + +- Validate inputs and return meaningful errors. +- Avoid exposing internal types. + +## Dependency Injection + +- Keep constructors simple. +- Prefer interfaces for external dependencies. + +## Testing + +- Add tests for business logic. +- Prefer deterministic tests (avoid timing flakiness). diff --git a/instructions/languages/go/go.instructions.md b/instructions/languages/go/go.instructions.md new file mode 100644 index 0000000..ebd64d5 --- /dev/null +++ b/instructions/languages/go/go.instructions.md @@ -0,0 +1,26 @@ +--- +description: Go standards for services and CLIs. +applyTo: "**/*.go" +--- + +# Go Instructions + +## Style + +- Follow `gofmt`. +- Prefer small packages with clear responsibilities. + +## Errors + +- Wrap errors with context. +- Prefer sentinel errors only when callers need to branch. + +## Concurrency + +- Avoid goroutine leaks. +- Use contexts for cancellation and timeouts. + +## Testing + +- Use table-driven tests. +- Avoid reliance on wall clock time. diff --git a/instructions/languages/java/java.instructions.md b/instructions/languages/java/java.instructions.md new file mode 100644 index 0000000..5d7600d --- /dev/null +++ b/instructions/languages/java/java.instructions.md @@ -0,0 +1,21 @@ +--- +description: Java standards for backend services. +applyTo: "**/*.java" +--- + +# Java Instructions + +## APIs + +- Keep public APIs stable and documented. +- Prefer immutability for DTOs. + +## Exceptions + +- Use checked exceptions sparingly. +- Provide actionable messages. + +## Testing + +- Add unit tests for logic. +- Use integration tests for persistence and HTTP boundaries. diff --git a/instructions/languages/kotlin/kotlin.instructions.md b/instructions/languages/kotlin/kotlin.instructions.md new file mode 100644 index 0000000..4b1db69 --- /dev/null +++ b/instructions/languages/kotlin/kotlin.instructions.md @@ -0,0 +1,21 @@ +--- +description: Kotlin standards for Android and JVM services. +applyTo: "**/*.kt" +--- + +# Kotlin Instructions + +## Idioms + +- Prefer data classes for simple models. +- Avoid nullable types when invariants can be enforced. + +## Coroutines + +- Use structured concurrency. +- Do not leak scopes. + +## Testing + +- Prefer deterministic tests. +- Test coroutine cancellation paths for async workflows. diff --git a/instructions/languages/lua/lua.instructions.md b/instructions/languages/lua/lua.instructions.md new file mode 100644 index 0000000..770e453 --- /dev/null +++ b/instructions/languages/lua/lua.instructions.md @@ -0,0 +1,20 @@ +--- +description: Lua standards for scripting and automation. +applyTo: "**/*.lua" +--- + +# Lua Instructions + +## Style + +- Keep modules small. +- Prefer explicit local variables. + +## Safety + +- Validate external inputs. +- Avoid dynamic `load` unless sandboxed. + +## Testing + +- Add tests for non-trivial transformations. diff --git a/instructions/languages/python/python.instructions.md b/instructions/languages/python/python.instructions.md new file mode 100644 index 0000000..8036233 --- /dev/null +++ b/instructions/languages/python/python.instructions.md @@ -0,0 +1,27 @@ +--- +description: Python standards for services, scripts, and libraries. +applyTo: "**/*.py" +--- + +# Python Instructions + +## Style + +- Follow PEP 8. +- Prefer type hints for public functions. +- Keep functions small and single-purpose. + +## Errors + +- Raise specific exception types. +- Include context in error messages. + +## Dependencies + +- Avoid adding new dependencies unless needed. +- Prefer the standard library when it is sufficient. + +## Testing + +- Add tests for bug fixes. +- Cover edge cases and error paths. diff --git a/instructions/languages/rust/rust.instructions.md b/instructions/languages/rust/rust.instructions.md new file mode 100644 index 0000000..796236e --- /dev/null +++ b/instructions/languages/rust/rust.instructions.md @@ -0,0 +1,21 @@ +--- +description: Rust standards for safe systems programming. +applyTo: "**/*.rs" +--- + +# Rust Instructions + +## Ownership + +- Prefer borrowing over cloning. +- Make lifetimes explicit only when necessary. + +## Errors + +- Prefer `thiserror`/`anyhow` if already used; otherwise keep error types simple. +- Include context when bubbling errors. + +## Testing + +- Add unit tests for parsing and invariants. +- Add property tests if the project already uses them. diff --git a/instructions/languages/swift/swift.instructions.md b/instructions/languages/swift/swift.instructions.md new file mode 100644 index 0000000..149e082 --- /dev/null +++ b/instructions/languages/swift/swift.instructions.md @@ -0,0 +1,21 @@ +--- +description: Swift standards for iOS/macOS apps. +applyTo: "**/*.swift" +--- + +# Swift Instructions + +## Style + +- Prefer value types where appropriate. +- Keep view code readable; extract complex logic. + +## Concurrency + +- Prefer `async`/`await`. +- Avoid blocking the main thread. + +## Testing + +- Add unit tests for domain logic. +- Add UI tests for critical flows where applicable. diff --git a/instructions/tools/docker/docker.instructions.md b/instructions/tools/docker/docker.instructions.md new file mode 100644 index 0000000..e7c9c29 --- /dev/null +++ b/instructions/tools/docker/docker.instructions.md @@ -0,0 +1,22 @@ +--- +description: Docker and containerization conventions. +applyTo: "**/{Dockerfile,Dockerfile.*,*.dockerfile,docker-compose*.yml,docker-compose*.yaml}" +--- + +# Docker Instructions + +## Images + +- Prefer small base images. +- Pin versions for reproducibility. +- Use multi-stage builds for production. + +## Security + +- Do not bake secrets into images. +- Prefer non-root users for runtime. + +## Caching + +- Order layers to maximize build cache. +- Separate dependency install from app copy when possible. diff --git a/instructions/tools/github-actions/github-actions.instructions.md b/instructions/tools/github-actions/github-actions.instructions.md new file mode 100644 index 0000000..e301515 --- /dev/null +++ b/instructions/tools/github-actions/github-actions.instructions.md @@ -0,0 +1,21 @@ +--- +description: GitHub Actions workflow conventions. +applyTo: ".github/workflows/**/*.{yml,yaml}" +--- + +# GitHub Actions Instructions + +## Reliability + +- Prefer pinned major versions for actions (e.g. `@v4`). +- Avoid overly-broad triggers. + +## Security + +- Use least-privilege permissions. +- Avoid printing secrets. + +## Maintainability + +- Keep jobs small and clearly named. +- Prefer reusable workflows when patterns repeat. diff --git a/instructions/tools/infra-as-code/terraform/terraform.instructions.md b/instructions/tools/infra-as-code/terraform/terraform.instructions.md new file mode 100644 index 0000000..f017458 --- /dev/null +++ b/instructions/tools/infra-as-code/terraform/terraform.instructions.md @@ -0,0 +1,26 @@ +--- +description: Terraform conventions and safety checks. +applyTo: "**/*.{tf,tfvars}" +--- + +# Terraform Instructions + +## Modules + +- Keep modules focused. +- Document inputs/outputs. + +## State Safety + +- Do not suggest `terraform state rm` unless explicitly asked. +- Avoid moving resources without a clear migration plan. + +## Variables + +- Use explicit types. +- Provide sane defaults only when safe. + +## Reviewability + +- Prefer deterministic `for_each` keys. +- Avoid complex nested conditionals when readability suffers. diff --git a/instructions/tools/testing/playwright/playwright.instructions.md b/instructions/tools/testing/playwright/playwright.instructions.md new file mode 100644 index 0000000..7576f74 --- /dev/null +++ b/instructions/tools/testing/playwright/playwright.instructions.md @@ -0,0 +1,21 @@ +--- +description: Playwright testing conventions. +applyTo: "**/*.{spec,test}.{ts,tsx,js,jsx}" +--- + +# Playwright Instructions + +## Stability + +- Prefer role-based selectors (`getByRole`) when available. +- Avoid fixed sleeps. +- Use explicit waits for navigation and network idle only when needed. + +## Structure + +- Keep tests independent. +- Reset state between tests. + +## Debugging + +- On flaky tests, add logging and screenshots/video only where helpful. diff --git a/instructions/workflows/code-review.instructions.md b/instructions/workflows/code-review.instructions.md new file mode 100644 index 0000000..0d2d127 --- /dev/null +++ b/instructions/workflows/code-review.instructions.md @@ -0,0 +1,13 @@ +--- +description: Workflow guidance for AI-assisted code review. +--- + +# Code Review Workflow + +When reviewing changes: + +1. Identify correctness and security risks first. +2. Call out behavioral changes and potential regressions. +3. Check error handling and edge cases. +4. Suggest tests when coverage is missing. +5. Prefer minimal changes that improve clarity. diff --git a/instructions/workflows/release.instructions.md b/instructions/workflows/release.instructions.md new file mode 100644 index 0000000..7f8ca5e --- /dev/null +++ b/instructions/workflows/release.instructions.md @@ -0,0 +1,12 @@ +--- +description: Workflow guidance for releasing changes. +--- + +# Release Workflow + +When asked to prepare a release: + +1. Summarize user-facing changes. +2. Confirm versioning scheme (SemVer or org standard). +3. Ensure CI passes. +4. Draft release notes with breaking changes called out. diff --git a/prompts/code-review/review-changes.prompt.md b/prompts/code-review/review-changes.prompt.md new file mode 100644 index 0000000..d402721 --- /dev/null +++ b/prompts/code-review/review-changes.prompt.md @@ -0,0 +1,15 @@ +--- +description: Review a PR diff and highlight risks and missing tests. +--- + +# Code Review Prompt + +Review the following changes: + + + +Output: + +- Issues ordered by severity +- Suggested fixes +- Missing tests / verification steps diff --git a/prompts/debugging/bug-triage.prompt.md b/prompts/debugging/bug-triage.prompt.md new file mode 100644 index 0000000..ade1cfa --- /dev/null +++ b/prompts/debugging/bug-triage.prompt.md @@ -0,0 +1,16 @@ +--- +description: Triage a bug report into root cause hypotheses and next steps. +--- + +# Bug Triage Prompt + +Bug report: + + + +Provide: + +- Clarifying questions +- Likely root causes +- Repro steps +- Minimal fix plan diff --git a/prompts/documentation/write-readme.prompt.md b/prompts/documentation/write-readme.prompt.md new file mode 100644 index 0000000..c88fbac --- /dev/null +++ b/prompts/documentation/write-readme.prompt.md @@ -0,0 +1,17 @@ +--- +description: Write or improve a project README. +--- + +# README Writing Prompt + +Project summary: + + + +Include: + +- What it does +- Quickstart +- Configuration +- Development workflow +- Troubleshooting diff --git a/skills/git-cli/SKILL.md b/skills/git-cli/SKILL.md new file mode 100644 index 0000000..0670c71 --- /dev/null +++ b/skills/git-cli/SKILL.md @@ -0,0 +1,16 @@ +--- +name: Git CLI +description: Help with safe Git workflows (branching, rebasing, release tags) and troubleshooting. +--- + +# Git CLI + +You can: + +- Suggest safe Git commands +- Explain diffs, conflicts, and history +- Draft concise commit messages + +Constraints: + +- Do not recommend destructive commands unless explicitly asked. diff --git a/skills/issue-triage/SKILL.md b/skills/issue-triage/SKILL.md new file mode 100644 index 0000000..7472a15 --- /dev/null +++ b/skills/issue-triage/SKILL.md @@ -0,0 +1,13 @@ +--- +name: Issue Triage +description: Turn messy bug reports into actionable tasks and reproduction steps. +--- + +# Issue Triage + +You can: + +- Ask clarifying questions +- Extract steps to reproduce +- Propose minimal fixes +- Suggest labels and priority diff --git a/skills/markdown-editor/SKILL.md b/skills/markdown-editor/SKILL.md new file mode 100644 index 0000000..10ed671 --- /dev/null +++ b/skills/markdown-editor/SKILL.md @@ -0,0 +1,12 @@ +--- +name: Markdown Editor +description: Write consistent, well-structured Markdown with working links and clean formatting. +--- + +# Markdown Editor + +You can: + +- Write README sections +- Maintain tables and ToCs +- Ensure lint-friendly formatting