docs: add AGENTS.md and CLAUDE.md contributor guides#743
Open
FBumann wants to merge 1 commit into
Open
Conversation
Adapted from the linopy project's guides, with linopy-specific details replaced by flixopt conventions (main branch, pip/pre-commit workflow, component-based xarray architecture). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
📝 WalkthroughWalkthroughAdds repository documentation for AI-assisted contribution rules, development workflows, project conventions, architecture, and guidance for AI agents through ChangesContribution guidance
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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.
Inline comments:
In `@AGENTS.md`:
- Around line 26-30: In the handwritten explanation near the
AI-generated-content note, update the typo “Thats” to “That’s” while leaving the
surrounding Markdown and wording unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Comment on lines
+26
to
+30
| ```markdown | ||
| Thats why this is important for me (handwritten) | ||
|
|
||
| > [!NOTE] | ||
| > The following content was generated by AI. |
Contributor
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the typo in the example.
Change “Thats” to “That’s” so contributors do not copy incorrect prose.
Proposed fix
- Thats why this is important for me (handwritten)
+ That's why this is important for me (handwritten)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| ```markdown | |
| Thats why this is important for me (handwritten) | |
| > [!NOTE] | |
| > The following content was generated by AI. |
🤖 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 `@AGENTS.md` around lines 26 - 30, In the handwritten explanation near the
AI-generated-content note, update the typo “Thats” to “That’s” while leaving the
surrounding Markdown and wording unchanged.
FBumann
enabled auto-merge (squash)
July 23, 2026 07:06
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
1 participant
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.
Adds
AGENTS.mdandCLAUDE.mdto the repo so AI agents (and humans) pick up the project's contribution rules and conventions automatically.Adapted from the linopy project's guides, with linopy-specific details stripped and replaced by flixopt conventions:
pip install -e ".[full,dev]"+pre-commit+pytest/ruffmain, tests undertests/astest_*.py, sharedconftest.pyfixturesCLAUDE.mdsimply importsAGENTS.mdvia@AGENTS.md. The AI-contribution rules (mark generated content, human writes their own intent, conversations aren't held through an agent) are carried over as-is.🤖 Generated with Claude Code
Summary by CodeRabbit