-
Notifications
You must be signed in to change notification settings - Fork 0
feat(standards): require language instruction file links in Org Standards section #343
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
68e5868
1fc01cf
17f8932
47442f7
e023f38
0dc3300
47938ae
e0061a4
b869d42
cba203e
a11fc57
205aba9
6ddbbd5
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
In the current patch, this new Useful? React with 👍 / 👎. |
||
|
|
||
| --- | ||
|
|
||
| ```markdown | ||
|
|
@@ -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._ | ||
| ``` | ||
|
|
||
| --- | ||
|
|
@@ -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 | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 Referenceand this file has no## Org Standardsheading. 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 👍 / 👎.