Adding agents md#484
Conversation
AGENTS.md is the agent-agnostic instruction file for all AI coding tools. CLAUDE.md is a thin stub that imports AGENTS.md via @AGENTS.md for Claude Code. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Adds a "Preparing a Pull Request" section covering target branch, PR scope, pre-PR checklist (unit + integration tests, linting, license headers), and detailed license header rules for new and existing files. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
hi @apaleyes , will still iterate on this a bit, but let me know what you think is missing or should be adjusted (perhaps some template for the PR text?). Also how interface classes starting with "I" are used could be extended... |
|
@mmahsereci looks reasonable! Overall i think agents.md is the best place to explain stuff that coding agents don't get, tricky and obscure aspects of the library. But we can only amass those with experience of using coding agents in Emukit dev. The docstring style from the other PR is a good example, and not an obvious one to think of |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #484 +/- ##
==========================================
+ Coverage 89.10% 89.18% +0.07%
==========================================
Files 137 137
Lines 4847 4843 -4
Branches 479 479
==========================================
Hits 4319 4319
+ Misses 402 398 -4
Partials 126 126 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…idelines Adds Coding Conventions section covering interface naming, docstring style (Sphinx/reST with example), optional dependencies, and documentation update rules for doc/api/ .rst files. Expands PR checklist with doc build verification, license header precision, and requirement to disclose AI agent involvement. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2 participants
Issue #, if available:
Description of changes:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.