Skip to content

docs(claude): correct 2 statements in the instructions file that are not true any more - #200

Merged
hyperpolymath merged 2 commits into
mainfrom
claude/instructions-file-facts
Nov 10, 2026
Merged

hyperpolymath merged 2 commits into
mainfrom
claude/instructions-file-facts

Conversation

@hyperpolymath

Copy link
Copy Markdown
Owner

Summary

.claude/CLAUDE.md is the instructions file that each agent session reads first. 2 of its statements are not true any more. The owner asked for the correction of these 2 places (2026-11-10).

Changes

1. The build caveat.

  • Before: Cargo.toml has a path dependency on gitbot-shared-context at ../../shared-context; a bare clone fails at dependency resolution; code work needs a gitbot-fleet checkout.
  • The fact now: gitbot-shared-context is a git dependency pinned by rev (Cargo.toml, line 29), as echidna-core is. A bare clone builds, and its tests run.
  • The note also named issue 18 for this debt. Issue 18 of this repository is about an rsa advisory, and it is closed.
  • The line about the same entry under "Sensitive files" now names the rev pins of the git dependencies.

2. The co-author trailer.

  • Before: the trailer named one model version.
  • A session with a different model then writes a false line, or does not follow the file.
  • Now: Co-Authored-By: Claude <noreply@anthropic.com>. The recent squash commits on main use this line already.

No other statement of the file is changed.

Not in this change

  • CONTRIBUTING.adoc (the section "Workspace caveat") and RSR_COMPLIANCE.adoc (2 lines) say the same thing about the path dependency. They are not changed here: the owner asked for the instructions file only.
  • The test counts in the same file ("full suite is 184") are older than the current suite. They are not changed.

Testing


Generated by Claude Code

…not true any more

1. The build caveat said that `Cargo.toml` has a path dependency on
   `gitbot-shared-context` at `../../shared-context`, that a bare clone
   fails at dependency resolution, and that code work needs a
   `gitbot-fleet` checkout. The dependency is a git dependency pinned by
   `rev` now. A bare clone builds, and its tests run: checked on
   2026-11-10 with Rust 1.99.0. The note also named issue 18 for this;
   issue 18 of this repository is about an `rsa` advisory and is closed.
   The line about the same entry under "Sensitive files" now names the
   `rev` pins.

2. The co-author trailer named one model version. A session with a
   different model then writes a false line, or does not follow the file.
   The trailer is now `Co-Authored-By: Claude <noreply@anthropic.com>`,
   which the recent commits on `main` use already.

No other statement of the file is changed.

Co-Authored-By: Claude <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0136P7ZmiFSCoB3UR9Kk56rK
@coderabbitai

coderabbitai Bot commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 40 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 9448a09e-6b5f-47cb-b1f1-0864405a6106
Commits

Reviewing files that changed from the base of the PR and between b865ba5 and 32820d6.

Files selected for processing: 1

  • .claude/CLAUDE.md

No actionable comments were generated in the recent review.

Summary

Summary by CodeRabbit

  • Documentation
    • Clarified that a bare clone can be built and tested with the documented toolchain.
    • Updated notes on Git dependency pins and the co-author trailer format.

The changes update .claude/CLAUDE.md with bare-clone build guidance, Git dependency pin guidance, and a model-neutral Claude co-author trailer.

Changes: Claude guidance updates

Layer / File(s) Summary
Document clone builds and Git dependency pins
.claude/CLAUDE.md
The guidance states that a bare clone builds and its tests run with the toolchain in rust-toolchain.toml, without a gitbot-fleet checkout. It also says to change the rev pins for gitbot-shared-context and echidna-core deliberately, with the reason stated in the commit.
Update the co-author trailer guidance
.claude/CLAUDE.md
The documented Claude co-author trailer no longer includes a model or version.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: Minimal · previous review b865b

The guidance update has no established merge-blocking issue and is mergeable after normal checks.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title clearly identifies the documentation change: correcting two statements in the Claude instructions file.
Description check Passed The description explains the build caveat and co-author trailer changes in .claude/CLAUDE.md.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: dc05badb-8649-4f00-9276-5c66f3fe8eb1
Commits

Reviewing files that changed from the base of the PR and between 55c7043 and b865ba5.

Files selected for processing: 1

  • .claude/CLAUDE.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Recent review details

Context from checks skipped due to timeout: 2

  • GitHub Check: CodeRabbit
  • GitHub Check: Dependency audit
Additional context used

LanguageTool

.claude/CLAUDE.md

[style] ~166-~166: Try using a descriptive adverb here.
Context: ...text, echidna-core). Move a pin only on purpose, and say why in the commit. - LICENS...

(ON_PURPOSE_DELIBERATELY)

[formatting] ~197-~197: These punctuation marks differ from each other. Use only one if you are ending a sentence.
Context: ...do not hand-edit*. - Co-author trailer: Co-Authored-By: Claude <noreply@anthropic.com>. The line has no model name and no ver...

(DOUBLE_PUNCTUATION_PREMIUM)

[typographical] ~198-~198: The conjunction “so that” does not have a comma in front.
Context: ...he line has no model name and no version, so that it is true for each session. - PR str...

(SO_THAT_UNNECESSARY_COMMA)

Additional comments: 3

.claude/CLAUDE.md: 3

165-167: LGTM!

197-199: LGTM!

121-122: Functional Correctness

The earlier hang report does not establish that the library tests hang on this revision. The reported full-suite run also does not establish the result with this revision’s dependencies. No applicable requirement to report a test run for the exact revision was established.

@hyperpolymath
hyperpolymath marked this pull request as ready for review November 10, 2026 18:20
@chatgpt-codex-connector

Copy link
Copy Markdown
Codex Review Summary: ❌ Failed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ❌ Failed 2026-11-10T18:20:43.924046Z
We couldn’t complete this review. Comment @codex review to try again.
b865ba5 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@hyperpolymath
hyperpolymath enabled auto-merge (squash) November 10, 2026 18:20
@hyperpolymath
hyperpolymath merged commit afa3a48 into main Nov 10, 2026
18 of 19 checks passed
@hyperpolymath
hyperpolymath deleted the claude/instructions-file-facts branch November 10, 2026 18:37
@sonarqubecloud

Copy link
Copy Markdown

hyperpolymath added a commit that referenced this pull request Nov 10, 2026
## Summary

3 documents said that `Cargo.toml` has a path dependency on
`gitbot-shared-context` at `../../shared-context`, and that a build
needs the gitbot-fleet layout. That is not true any more. `Cargo.toml`
takes the crate as a git dependency with a `rev` pin (line 29), and a
bare clone builds and runs its tests.

#200 corrected the same statement in the instructions file. This pull
request corrects the documents for people.

## Changes

- **`CONTRIBUTING.adoc`**: the section "Workspace caveat" becomes "Build
from a bare clone", with the true statement. The 3 workarounds go out,
because nothing needs a workaround. The checklist item `cargo test`
loses its caveat.
- **`RSR_COMPLIANCE.adoc`**: the row for the path dependency goes out of
the table of known deviations. The action item "Resolve
`gitbot-shared-context` path dependency" is marked as done.
- **`README.adoc`**: 1 comment line in the build example. It said
"requires gitbot-fleet layout" and pointed to `CONTRIBUTING.md`. The
file is `CONTRIBUTING.adoc`.

The owner asked for `CONTRIBUTING.adoc` and `RSR_COMPLIANCE.adoc`. The
`README.adoc` line has the same false statement and points to the
section that changes here, so it is in this pull request too.

The 2 files named issue 18 as the tracker of the path dependency. Issue
18 is about another subject (`rsa`) and is closed, so the new text names
no issue.

## Testing

- Evidence for the statement: in a bare clone of this repository, `cargo
test --locked` ran in this session with exit 0 (at `1a6908e`, Rust
1.99.0, the toolchain of `rust-toolchain.toml`). No gitbot-fleet
checkout was present.
- `grep` for the old statement in `*.adoc`, `*.md`, `*.a2ml` and
`*.toml` after the change: the only hits are the 2 sentences that say
the old statement is not true any more.
- The table in `RSR_COMPLIANCE.adoc` still has its `|===` end line. I
did not render the documents.

---
_Generated by [Claude
Code](https://claude.ai/code/session_0136P7ZmiFSCoB3UR9Kk56rK)_

Co-authored-by: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants