-
Notifications
You must be signed in to change notification settings - Fork 8
Add AGENTS.md and CONTRIBUTING.md
#377
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
tien-tong
wants to merge
1
commit into
main
Choose a base branch
from
add-agent
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+480
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| # AGENTS.md | ||
|
|
||
| This file gives AI coding agents the extra operating rules for this repository. | ||
| It is not a replacement for the contributor guide. | ||
|
|
||
| ## Mandatory First Step | ||
|
|
||
| Read `CONTRIBUTING.md` before making code changes, commits, or pull requests. | ||
| That file is the source of truth for repository layout, setup, commands, CI, | ||
| testing, docs, release evidence, and undocumented conventions. | ||
|
|
||
| Do not guess project conventions. If a workflow is not documented in | ||
| `CONTRIBUTING.md` or repository files, say so instead of inventing one. | ||
|
|
||
| ## Work From Local Evidence | ||
|
|
||
| Before changing an area, inspect the current source, tests, and docs that own | ||
| that behavior. In particular: | ||
|
|
||
| - CLI changes usually involve `babs/cli.py`, implementation modules, tests, and | ||
| matching `docs/babs-*.rst` pages. | ||
| - Scheduler, status, submit, and merge changes require extra care because BABS | ||
| is built around DataLad, git-annex, Singularity/Apptainer, and SLURM. | ||
| - Generated script or YAML changes should be checked against `babs/templates/`, | ||
| packaged YAML files, examples, and relevant tests. | ||
| - Documentation changes should account for `README.rst` being included by | ||
| `docs/index.rst`. | ||
|
|
||
| ## Agent Change Discipline | ||
|
|
||
| - Check the worktree before editing and do not overwrite unrelated user changes. | ||
| - Keep edits scoped to the requested behavior. | ||
| - Update tests and documentation when behavior, CLI flags, generated outputs, or | ||
| example configuration semantics change. | ||
| - Use the tools and commands documented in `CONTRIBUTING.md`; do not substitute | ||
| unrelated workflows. | ||
| - If Docker, SLURM, Singularity/Apptainer, DataLad credentials, or other | ||
| external requirements are unavailable, report the limitation clearly. | ||
| - Do not claim tests, linting, docs builds, package builds, or manual SLURM | ||
| checks passed unless they were actually run. | ||
|
|
||
| ## Do Not Invent | ||
|
|
||
| Do not infer or invent project conventions that are not explicitly documented in | ||
| `CONTRIBUTING.md` or present in repository files. This includes branch naming, | ||
| commit/PR format, ownership, release/changelog process, scheduler setup, or | ||
| tooling stacks. | ||
|
|
||
| If a convention is missing, state that it is undocumented and ask for guidance | ||
| instead of guessing. | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
dupe of "Do not invent"