Narrow .github/copilot-instructions.md and add user-level globals section#57
Merged
Conversation
Two changes vs the original 38-line file: 1. Remove project description / Framer setup / font loading / deployment restatement — those are in CLAUDE.md, which Copilot's PR review bot also reads (cap ~4,000 chars per file). Duplicating here is drift surface with no leverage. 2. Add a "Global rules to flag" section restating Joe's user-level conventions (no emojis, no AI attribution, sentence case, banned words). Copilot does NOT read ~/.claude/CLAUDE.md, so the bot can only enforce these rules if they're present in this file. What stays: project-specific bug classes (no hardcoded API keys, Airtable whitelist validation, plus any others kept from the original).
There was a problem hiding this comment.
Pull request overview
This PR streamlines .github/copilot-instructions.md by removing duplicated project context (now referenced in CLAUDE.md) and by adding a dedicated section for user-level global conventions so Copilot’s PR review can consistently flag them.
Changes:
- Replaces repeated project/theme/deploy details with a pointer to
CLAUDE.md. - Adds a “Global rules to flag” section covering sentence case, emoji/attribution bans, banned words, filler phrases, and required HTML meta/favicon tags.
- Keeps and consolidates repo-specific “bug classes to flag” (event listener scope, SVG
<style>leakage,transition: all, no build step, model name staleness, etc.).
| - Flag these banned words: "comprehensive", "robust", "leveraging", "seamlessly", "innovative", "cutting-edge", "holistic", "synergy", "ecosystem", "paradigm", "empower", "transformative", "sophisticated", "state-of-the-art". | ||
| - Flag filler phrases: "it's worth noting", "in order to" (use "to"), "at the end of the day", "moving forward". | ||
| - Never include AI attribution ("Generated with Claude Code", etc.) in PRs, commits, code, or docs. | ||
| - **Sentence case** in headings, UI text, and identifiers. Title Case is a regression. |
| - Never include AI attribution ("Generated with Claude Code", etc.) in PRs, commits, code, or docs. | ||
| - **Sentence case** in headings, UI text, and identifiers. Title Case is a regression. | ||
| - **No emojis** in source code, log messages, comments, commits, PR bodies, or any output. Plain text only. | ||
| - **No AI attribution.** Never include "Generated with Claude Code", `Co-Authored-By: Claude` trailers, or any AI/model/company attribution in PRs, commits, code, or any committed file. |
| - **No AI attribution.** Never include "Generated with Claude Code", `Co-Authored-By: Claude` trailers, or any AI/model/company attribution in PRs, commits, code, or any committed file. | ||
| - **Banned words** (delete or replace): *comprehensive, sophisticated, robust, transformative, leveraging, seamlessly, innovative, cutting-edge, state-of-the-art, holistic, synergy, ecosystem, paradigm, empower*. | ||
| - **Filler phrases** (delete or rewrite): *it's worth noting, in order to (use "to"), at the end of the day, moving forward*. | ||
| - **Every HTML page must have an SVG favicon and full OG/Twitter meta tags.** Required tags: `og:title`, `og:description`, `og:type`, `og:url`, `og:image` (1200x630), `og:image:width`, `og:image:height`, `twitter:card` (`summary_large_image`), `twitter:title`, `twitter:description`, `twitter:image`. |
…irements - Sentence-case rule scoped to prose/UI/comments; identifiers follow language conventions - AI-attribution rule narrowed to authorship credits, not model/company mentions - Favicon and OG/Twitter rule names the exact <link> tag and meta keys so the bot can pattern-match them on review
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two changes vs the original 38-line file
1. Remove duplication with CLAUDE.md. Project description, Amditis V2 theme palette restatement, deployment notes, and architecture details are already in CLAUDE.md, which Copilot's PR review bot also reads (cap ~4,000 chars per file). Duplicating here is drift surface with no leverage — when one drifts the other goes stale.
2. Add a 'Global rules to flag' section. Restates Joe's user-level conventions (no emojis, no AI attribution, sentence case, banned words, filler phrases, HTML favicon + OG tags). Copilot's PR review bot does NOT read
~/.claude/CLAUDE.md, so the bot can only enforce these rules if they're present in this file.What stays
Project-specific bug classes: no hardcoded API keys, event-listener scope gotcha (sidebar/modal outside
#llm-tool-advisor-container), generic class names in SVG<style>tags,transition: all,defer'd library load-order assumptions, build-step regressions, outdated model names, theme drift,rel="noopener noreferrer"on external links, inline event handlers.Pattern reference
Same pattern shipped in stash#36 and reroute-nj#25.
Verification
wc -c .github/copilot-instructions.mdreturns 3219 (well under 4000)