Skip to content
Open
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
12 changes: 9 additions & 3 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,15 @@ Copilot-focused summary; AGENTS.md is authoritative when they conflict. Read the
standard in [`standards/`](../standards/) before touching CI, repo settings, or agent
configuration.

Language-specific rules are applied automatically via files in `.github/instructions/`:
`typescript`, `javascript`, `python`, `go`, `terraform`, and `shell` — see those files for
per-language guidance.
Language-specific rules are applied automatically via files in `.github/instructions/` when you
open a matching file type. Canonical files in this repo (deployed verbatim to each target repo):
Comment on lines +24 to +25
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Put the canonical link list in the required section

This file is still advertised below as the starting point to copy into each repo, but the new language-instruction list is added under ## Standards Reference and this file has no ## Org Standards heading. Repos that follow this canonical file can therefore include the links yet still fail the new standard's requirement that they be listed in ## Org Standards, so the live example should either add that section or move the list there.

Useful? React with 👍 / 👎.


- [`typescript.instructions.md`](instructions/typescript.instructions.md) — strict config, branded types, DDD/CQRS, pino, React, Electron IPC
- [`javascript.instructions.md`](instructions/javascript.instructions.md) — style, JSDoc type annotations, error handling
- [`python.instructions.md`](instructions/python.instructions.md) — black/ruff, type annotations, structlog, pytest, GAS companion code
- [`go.instructions.md`](instructions/go.instructions.md) — naming, gofmt, slog, error wrapping, concurrency, HTTP, testing, security
- [`terraform.instructions.md`](instructions/terraform.instructions.md) — fmt, tflint, tfsec, trivy, state management, security
- [`shell.instructions.md`](instructions/shell.instructions.md) — safety flags, ShellCheck, quoting, error handling, Makefile standards

## Core Development Rules

Expand Down
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -390,3 +390,8 @@ private.yml
# End of petry-projects secrets baseline
# ============================================================================
.dev-lead/
.dev-lead/
.dev-lead/
.dev-lead/
.dev-lead/
.dev-lead/
20 changes: 19 additions & 1 deletion standards/copilot-instructions-standard.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,10 @@ only document what differs or adds detail.
A repo-level `copilot-instructions.md` MUST include the following sections. Keep the file to
approximately two pages — concise, specific, and actionable.

The `## Org Standards` section MUST list every language-specific `.instructions.md` file deployed
to `.github/instructions/` in that repo, each with a one-line scope description. This makes the
path-specific files discoverable without requiring contributors to browse the directory.
Comment on lines +95 to +97
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Enforce the new Org Standards language-link requirement

In the current patch, this new MUST makes language links a required section, but the weekly audit still only checks for Tech Stack and Local Dev Commands in scripts/compliance-audit.sh (required_sections at lines 1101-1111) while this same document says the audit enforces the standard automatically. Repos can therefore omit every language-instruction link and still pass the compliance audit, creating a false compliance signal for the discoverability requirement introduced here.

Useful? React with 👍 / 👎.


---

```markdown
Expand Down Expand Up @@ -147,7 +151,19 @@ apply.]
## Org Standards

See [petry-projects/.github — AGENTS.md](https://github.com/petry-projects/.github/blob/main/AGENTS.md)
for full development standards.
for org-wide development standards.

**Language-specific instructions** (applied automatically by Copilot when you open matching file types):

- [TypeScript / TSX](instructions/typescript.instructions.md) — [strict config, branded types, DDD/CQRS, pino, React/Electron as applicable]
- [JavaScript](instructions/javascript.instructions.md) — [style, JSDoc, error handling]
- [Go](instructions/go.instructions.md) — [naming, gofmt, slog, error wrapping, concurrency, testing]
- [Shell](instructions/shell.instructions.md) — [safety flags, ShellCheck, quoting, error handling]
- [Python](instructions/python.instructions.md) — [black/ruff, type annotations, structlog, pytest]
- [Terraform](instructions/terraform.instructions.md) — [fmt, tflint, security scanning, state management]

_List only the files actually deployed to `.github/instructions/` for this repo.
Omit this block entirely if no language instruction files were deployed._
```

---
Expand All @@ -162,13 +178,15 @@ for full development standards.
- Coverage thresholds and testing tools specific to this repo
- Architecture patterns unique to this repo (e.g., Electron IPC conventions, GAS extraction pattern)
- Any rule that overrides or refines the org-level defaults
- Links to every language-specific `.instructions.md` file deployed to `.github/instructions/`, each with a one-line scope description (list only files that are actually present)

**Do NOT include in repo-level instructions:**

- Org-wide rules already covered in `copilot-instructions.md` (SOLID, TDD, logging format, etc.)
- Rules already covered in language-specific `.instructions.md` files
- Content already documented in `AGENTS.md`
- Secrets, API keys, credentials, or example tokens with real values
- Links to language instruction files that were not deployed to this repo's `.github/instructions/`

## Content Quality Rules

Expand Down
Loading