Skip to content

Add agent instructions and GitHub configuration borrowed from CoolProp - #58

Merged
henningjp merged 4 commits into
CoolProp:masterfrom
henningjp:docs/agent-instructions
Oct 23, 2026
Merged

henningjp merged 4 commits into
CoolProp:masterfrom
henningjp:docs/agent-instructions

Conversation

@henningjp

Copy link
Copy Markdown
Contributor

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 the IF97.cpp verification program, conventions (CRLF line endings, Region 3 iteration, semantic versioning, numerical-change checks), a pre-PR review checklist, and session completion. Links to AGENTS.md.
  • AGENTS.md: the AI assistance and attribution policy: when to attribute, the Co-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 in IF97.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

  • Dependabot will start opening a weekly PR for Actions updates. Remove .github/dependabot.yml if that is unwanted.
  • The PR template applies to all future PRs, including from outside contributors.
  • CLAUDE.md asks agents to push at the end of a session. A maintainer's untracked CLAUDE.local.md can override that, and the file says so.

Testing

No code changes. The Dependabot file and the AGENTS.md anchor 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

henningjp and others added 4 commits October 23, 2026 06:01
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
@coderabbitai

coderabbitai Bot commented Oct 23, 2026

Copy link
Copy Markdown
Contributor

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 13 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 2 included reviews 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: CHILL
  • Plan: Advanced
  • Run ID: 027f23ed-27bc-4756-ae64-a66983017af3
📥 Commits

Reviewing files that changed from the base of the PR and between 50b6559 and b1a1903.

📒 Files selected for processing: 5
  • .coderabbit.yaml
  • .github/PULL_REQUEST_TEMPLATE.md
  • .github/dependabot.yml
  • AGENTS.md
  • CLAUDE.md
  • 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

Comment @coderabbitai help to get the list of available commands.

@henningjp
henningjp merged commit 3461325 into CoolProp:master Oct 23, 2026
5 checks passed
@henningjp
henningjp deleted the docs/agent-instructions branch October 23, 2026 10:17
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.

1 participant