chore: clean repository layout guidance#816
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR cleans up repository layout guidance and removes non-durable generated scaffolds, while consolidating durable example content under the canonical example/ tree and recording a CI generation boundary decision.
Changes:
- Removed root-level generated app scaffolds (
mytest2,test-*) and their standalone module files/workflows. - Added/updated durable documentation for repo layout + agent guidance (
docs/REPO_LAYOUT.md,docs/AGENT_GUIDE.md, ADRdecisions/0045-*), and linked it from top-level docs. - Added a minimal strict-proto external plugin example under
example/external-plugin/and updated example indices and module deps accordingly.
Reviewed changes
Copilot reviewed 62 out of 71 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| test-ui-plugin/workflow.yaml | Remove generated scaffold workflow config. |
| test-ui-plugin/README.md | Remove generated scaffold documentation. |
| test-ui-plugin/main.go | Remove generated scaffold app entrypoint. |
| test-ui-plugin/go.mod | Remove generated scaffold module definition. |
| test-ui-plugin/Dockerfile | Remove generated scaffold container build. |
| test-ui-plugin/.gitignore | Remove generated scaffold ignore rules. |
| test-ui-plugin/.github/workflows/ci.yml | Remove generated scaffold CI workflow. |
| test-plugin/workflow.yaml | Remove generated scaffold workflow config. |
| test-plugin/README.md | Remove generated scaffold documentation. |
| test-plugin/main.go | Remove generated scaffold app entrypoint. |
| test-plugin/go.sum | Remove generated scaffold dependency locks. |
| test-plugin/go.mod | Remove generated scaffold module definition. |
| test-plugin/Dockerfile | Remove generated scaffold container build. |
| test-plugin/.gitignore | Remove generated scaffold ignore rules. |
| test-plugin/.github/workflows/ci.yml | Remove generated scaffold CI workflow. |
| test-full-stack/workflow.yaml | Remove generated scaffold workflow config. |
| test-full-stack/README.md | Remove generated scaffold documentation. |
| test-full-stack/main.go | Remove generated scaffold app entrypoint. |
| test-full-stack/go.mod | Remove generated scaffold module definition. |
| test-full-stack/Dockerfile | Remove generated scaffold container build. |
| test-full-stack/.gitignore | Remove generated scaffold ignore rules. |
| test-full-stack/.github/workflows/ci.yml | Remove generated scaffold CI workflow. |
| test-event-processor/workflow.yaml | Remove generated scaffold workflow config. |
| test-event-processor/README.md | Remove generated scaffold documentation. |
| test-event-processor/main.go | Remove generated scaffold app entrypoint. |
| test-event-processor/go.mod | Remove generated scaffold module definition. |
| test-event-processor/Dockerfile | Remove generated scaffold container build. |
| test-event-processor/.gitignore | Remove generated scaffold ignore rules. |
| test-event-processor/.github/workflows/ci.yml | Remove generated scaffold CI workflow. |
| test-api/workflow.yaml | Remove generated scaffold workflow config. |
| test-api/README.md | Remove generated scaffold documentation. |
| test-api/main.go | Remove generated scaffold app entrypoint. |
| test-api/go.mod | Remove generated scaffold module definition. |
| test-api/Dockerfile | Remove generated scaffold container build. |
| test-api/.gitignore | Remove generated scaffold ignore rules. |
| test-api/.github/workflows/ci.yml | Remove generated scaffold CI workflow. |
| test-api-service/workflow.yaml | Remove generated scaffold workflow config. |
| test-api-service/README.md | Remove generated scaffold documentation. |
| test-api-service/main.go | Remove generated scaffold app entrypoint. |
| test-api-service/go.mod | Remove generated scaffold module definition. |
| test-api-service/Dockerfile | Remove generated scaffold container build. |
| test-api-service/.gitignore | Remove generated scaffold ignore rules. |
| test-api-service/.github/workflows/ci.yml | Remove generated scaffold CI workflow. |
| README.md | Link to new repository layout documentation. |
| mytest2/workflow.yaml | Remove generated scaffold workflow config. |
| mytest2/README.md | Remove generated scaffold documentation. |
| mytest2/main.go | Remove generated scaffold app entrypoint. |
| mytest2/go.mod | Remove generated scaffold module definition. |
| mytest2/Dockerfile | Remove generated scaffold container build. |
| mytest2/.gitignore | Remove generated scaffold ignore rules. |
| mytest2/.github/workflows/ci.yml | Remove generated scaffold CI workflow. |
| example/README.md | List full app/plugin examples under example/. |
| example/go.sum | Update example module dependency locks after reorg/new example. |
| example/go.mod | Update example module dependencies for external plugin example. |
| example/external-plugin/README.md | Add minimal strict-proto external plugin build instructions. |
| example/external-plugin/main.go | Add minimal strict-proto external plugin implementing step.uppercase. |
| docs/REPO_LAYOUT.md | Add authoritative repository layout + placement rules. |
| docs/EXAMPLES.md | Document full app/plugin examples under example/. |
| docs/AGENT_GUIDE.md | Add centralized agent operating guidance and commands. |
| decisions/0045-ci-generation-boundary.md | Record ADR for CI generation boundary (core-first renderers). |
| decisions/0015-docker-cve-risk-acceptance.md | Update ADR context after removing extra scaffold modules. |
| CONTRIBUTING.md | Point to docs/REPO_LAYOUT.md as authoritative structure guidance. |
| CLAUDE.md | Replace long guidance with short pointers to docs/ guides. |
| AGENTS.md | Add short root agent instructions pointing to docs/ guides. |
| .github/copilot-instructions.md | Shorten Copilot instructions; link to detailed docs for guidance. |
⏱ Benchmark Results✅ No significant performance regressions detected. benchstat comparison (baseline → PR)
|
* fix: close workflow issue audit gaps * fix: return conditional route inspection errors * fix: address ci review gaps * fix: inspect aliased conditional routes
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
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.
Summary
examples/into the canonicalexample/treemytest2,test-*) that were not referenced by tests or docs as durable fixturesdocs/Verification
cd example && GOWORK=off go mod tidycd example && GOWORK=off go build ./...GOWORK=off go test -run TestExampleConfigsLoad -count=1 ./...cd example && GOWORK=off golangci-lint run ./...GOWORK=off go test ./...git diff --check