Repository navigation
Add agent instructions and GitHub configuration borrowed from CoolProp - #58
Merged
Merged
Conversation
CLAUDE.md gives project, build, and convention notes for agents. AGENTS.md holds the AI assistance and attribution policy that CLAUDE.md links to. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01987ucTxkBkJvLLXZbPf2ye
Tell the reviewer not to comment on identifier naming or casing, as in CoolProp. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01987ucTxkBkJvLLXZbPf2ye
Based on the CoolProp template, with IF97 verification and AI attribution prompts. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01987ucTxkBkJvLLXZbPf2ye
Weekly, with minor and patch updates grouped into one PR. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01987ucTxkBkJvLLXZbPf2ye
Contributor
|
Warning Review limit reachedYou'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 13 minutes. View limit details
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. Comment |
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.
What
Adds instructions for AI coding agents and some GitHub repository configuration, borrowed from the sibling CoolProp repo and adapted for IF97.
Why
IF97 is now developed alongside CoolProp with AI assistance, and CoolProp already has agent instructions, an AI attribution policy, a CodeRabbit configuration, a PR template, and Dependabot updates. Bringing the relevant parts here gives agents and contributors the same expectations in both repos, and gives reviewers a consistent PR format. No library code changes.
Changes
Each item below is taken from CoolProp and edited for IF97. Anything specific to CoolProp (Linear and Beads issue tracking, SBTL and REFPROP test rules,
preflight.sh,dev/agent-notes.md, its CodeQL and actionlint configs) was left out.CLAUDE.md: project overview, build and test steps for theIF97.cppverification program, conventions (CRLF line endings, Region 3 iteration, semantic versioning, numerical-change checks), a pre-PR review checklist, and session completion. Links toAGENTS.md.AGENTS.md: the AI assistance and attribution policy: when to attribute, theCo-authored-by:trailer, a PR note on what the AI did and what the human verified, and what attribution does not change (correctness, testing, validation of scientific claims against IAPWS references, provenance and licensing)..coderabbit.yaml: copied unchanged. It tells CodeRabbit not to comment on identifier naming or casing..github/PULL_REQUEST_TEMPLATE.md: CoolProp's Description, Benefits, Possible Drawbacks, and Verification sections, with IF97 prompts for tests inIF97.cpp, IAPWS citations, worst-case error against the tables, and an AI attribution note..github/dependabot.yml: weekly GitHub Actions version updates, with minor and patch updates grouped into one PR. CoolProp's issue reference, commit prefix, and labels were dropped.Possible Drawbacks
.github/dependabot.ymlif that is unwanted.CLAUDE.mdasks agents to push at the end of a session. A maintainer's untrackedCLAUDE.local.mdcan override that, and the file says so.Testing
No code changes. The Dependabot file and the
AGENTS.mdanchor link have not been validated by GitHub yet; the first Dependabot run will show up under Insights, then Dependency graph, then Dependabot.🤖 Generated with Claude Code
https://claude.ai/code/session_01987ucTxkBkJvLLXZbPf2ye