docs: track CLAUDE.md and update it for the Go legacy backend#5107
Merged
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughAdds a Claude Code repository guide covering architecture, workflows, environments, contribution conventions, and CI. Removes the ChangesRepository guidance
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Contributor
There was a problem hiding this comment.
Pull request overview
Tracks shared repository guidance and updates it for the Go legacy backend.
Changes:
- Adds current backend architecture and development instructions.
- Stops ignoring
CLAUDE.md. - Documents CI, deployment, and licensing conventions.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
CLAUDE.md |
Adds versioned repository guidance. |
.gitignore |
Allows CLAUDE.md to be tracked. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
CLAUDE.md (1)
95-97: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winMake the Speckit plan reference actionable.
“Read the current plan” does not identify a file, command, or link. Document where contributors should find it, or confirm that external tooling resolves this marker before publication.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@CLAUDE.md` around lines 95 - 97, Update the Speckit guidance surrounding the “SPECKIT END” marker to make the plan reference actionable: identify the plan’s file or location, provide the command or link contributors should use, or explicitly confirm that external tooling resolves the marker before publication.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@CLAUDE.md`:
- Around line 95-97: Update the Speckit guidance surrounding the “SPECKIT END”
marker to make the plan reference actionable: identify the plan’s file or
location, provide the command or link contributors should use, or explicitly
confirm that external tooling resolves the marker before publication.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 840ba0d1-38c1-4e92-8bc4-1d8983b44a5c
📒 Files selected for processing (2)
.gitignoreCLAUDE.md
💤 Files with no reviewable changes (1)
- .gitignore
Un-ignore CLAUDE.md (was added to .gitignore in 9b338dc) so the repo guidance is shared, and correct its stale content: the Python v1/v2 backend was removed and /v1,/v2 are now served by the Go cla-backend-legacy module deployed via the cla-backend Serverless stack. Update the repository layout, replace the Python backend section with legacy Go build/run instructions, and fix the CI notes. Note for reviewers: anyone keeping a private local CLAUDE.md must move it aside before pulling this change. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Michal Lehotsky <mlehotsky@linuxfoundation.org>
mlehotskylf
force-pushed
the
docs/update-claude-md-backend-layout
branch
from
070e2ba to
93c243b
Compare
lukaszgryglicki
previously approved these changes
Jul 13, 2026
lukaszgryglicki
left a comment
lukaszgryglicki
left a comment
Member
There was a problem hiding this comment.
/lgtm - please see Copilot's feedback and eventually address @mlehotskylf
Address review comments from copilot-pull-request-reviewer[bot]: - CLAUDE.md: clarify cla-backend/ retains the API Gateway authorizer as its sole application code, rather than claiming it has none (per copilot) - CLAUDE.md: narrow the three-layer module split claim to "most" v2/ packages, noting handler-only and generated-client exceptions (per copilot) - CLAUDE.md: name the actual deploy scripts (deploy:dev/staging/prod) instead of implying a script exists per environment (per copilot) - CLAUDE.md: clarify check-headers.sh does not scan Markdown and that only cla-backend-go's make lint invokes it, not cla-backend-legacy's (per copilot) Resolves 6 review threads. Signed-off-by: Michal Lehotsky <mlehotsky@linuxfoundation.org>
Collaborator
Author
|
Re coderabbitai's nitpick about the "Speckit plan reference" near lines 95-97 in an earlier revision: that content no longer exists in CLAUDE.md (the file now ends at the CI section, line ~92). Treating this as outdated/already addressed. |
Collaborator
Author
Review Feedback AddressedCommit: e22021a Changes Made
Threads Resolved6 of 6 unresolved threads addressed (two review passes had flagged the same 4 issues, so 6 threads collapsed to 4 distinct fixes). Questions Answered
|
Address review comments from copilot-pull-request-reviewer[bot]: - CLAUDE.md: document both bin/cla-mac (make build-mac) and bin/cla (make build-linux) launch commands, since Linux writes a different binary name - CLAUDE.md: clarify check-headers.sh only verifies the copyright line, not the SPDX identifier, which is convention-only and unchecked Resolves 2 review threads. Signed-off-by: Michal Lehotsky <mlehotsky@linuxfoundation.org>
Collaborator
Author
Review Feedback Addressed (follow-up)Commit: 06b3c7e Changes Made
Threads Resolved2 of 2 new unresolved threads addressed (raised after the previous push). |
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
CLAUDE.md(it was added to.gitignorein 9b338dc) so the Claude Code repo guidance is shared and versioned./v1//v2backend has been removed (5d87c67); those endpoints are now served by the Gocla-backend-legacymodule, built asbin/legacy-api-lambdaand deployed via thecla-backendServerless stack on the originalapi.*domains.cla-backend/as the deployment stack (Go binaries only: v3 API, dynamo-events, metrics, zipbuilder, gitlab-repository-check, user-subscribe, legacy API, authorizer) andcla-backend-legacy/as the Go legacy API module with its parity tooling.yarn serve:dev) with legacy-Go build/run instructions (make lambdas,STAGE=dev ADDR=":5000" make run-local, Cypress helpers on :5000).Note for reviewers
Tracking
CLAUDE.mdreverses the earlier decision to gitignore it. Anyone keeping a private localCLAUDE.mdwill need to move it aside before pulling this change (git will refuse to overwrite the untracked file). If the original intent was per-developer private guidance, please say so and this PR can be closed in favor of keeping it local-only.🤖 Generated with Claude Code