docs: add repository gotchas to copilot-instructions#421
Open
spboyer wants to merge 1 commit into
Open
Conversation
Capture recurring friction patterns observed across recent sessions: - web/dist stub needed for //go:embed on fresh worktrees - Don't restage regenerated web/dist/index.html - gofmt -> test -> lint verify chain - Clean up .impeccable/ and node_modules before committing Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s Copilot instructions to capture recurring “gotchas” observed in past Copilot CLI sessions, aiming to reduce repeated friction when setting up/building/testing in fresh environments.
Changes:
- Adds a “Repository Gotchas” section with guidance around
web/diststubbing forgo:embed. - Documents handling of
web/dist/index.htmlbeing tracked whileweb/dist/assets/is ignored. - Recommends a standard local verification flow (format → test → lint) and pre-commit cleanup steps.
Show a summary per file
| File | Description |
|---|---|
| .github/copilot-instructions.md | Adds a new “Repository Gotchas” section with setup/verification/cleanup guidance to prevent common session pitfalls. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 2
- Review effort level: Low
Comment on lines
+97
to
+99
| ```bash | ||
| gofmt -w ./... && go test ./... && golangci-lint run | ||
| ``` |
| worktree the built assets don't exist, so any Go command fails until you scaffold them: | ||
|
|
||
| ```bash | ||
| mkdir -p web/dist && [ -f web/dist/index.html ] || echo '<html></html>' > web/dist/index.html |
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.
Captures recurring friction patterns observed across ~70 recent Copilot CLI sessions in this repo, so future sessions don't rediscover them.
Added: "Repository Gotchas" section
web/diststub — Go binary embeds dashboard via//go:embed all:dist(web/embed.go). Fresh worktrees have no built assets, sogo build/test/lintfails until you scaffoldweb/dist/index.html. Seen in 7+ sessions.web/dist/index.html—web/dist/assets/*is gitignored butindex.htmlis tracked.npm run buildrewrites it with new hashed refs; revert unless intentional. Seen in 5+ sessions.gofmt → test → lint—golangci-lintfails on unformatted code, forcing retry cycles..impeccable/,web/node_modules/,site/node_modules/should never be staged.Sourced from
/chronicle improveanalysis of session store data.