Skip to content

docs: add AGENTS.md with contribution rules for AI agents - #15121

Merged
cclauss merged 2 commits into
TheAlgorithms:masterfrom
priya-sundaram-dev:add-agents-md
Aug 30, 2026
Merged

docs: add AGENTS.md with contribution rules for AI agents#15121
cclauss merged 2 commits into
TheAlgorithms:masterfrom
priya-sundaram-dev:add-agents-md

Conversation

@priya-sundaram-dev

Copy link
Copy Markdown
Contributor

Describe your change:

Adds a model-neutral AGENTS.md at the repo root, as suggested by @cclauss in #15119, so AI coding agents (and their humans) have a single place that records the conventions that most often trip up automated PRs.

The headline rule is the one that keeps closing bot PRs: algorithms-keeper closes any PR whose "Describe your change" section has no checked box, so the file tells agents to tick the template before submitting. It also summarizes the ruff / type-hint / doctest / naming / placement requirements and points at CONTRIBUTING.md as the source of truth (it never overrides it).

I used the vendor-neutral AGENTS.md filename (the emerging cross-tool convention) rather than a tool-specific one so every agent picks it up.

  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.

Adds a model-neutral AGENTS.md at the repo root summarizing the
conventions that most often trip up automated contributors, most
importantly that algorithms-keeper closes any PR without a checked
box in the 'Describe your change' section. Complements CONTRIBUTING.md.
@algorithms-keeper algorithms-keeper Bot added documentation This PR modified documentation files awaiting reviews This PR is ready to be reviewed labels Aug 30, 2026
@cclauss

cclauss commented Aug 30, 2026

Copy link
Copy Markdown
Member

Nice but… This project uses uv and has no requirements.txt.

Would it be better to suggest commands like:
uvx ruff …
uvx pre-commit …
uvx pytest

@priya-sundaram-dev

Copy link
Copy Markdown
Contributor Author

Good catch — done in e0fbc95. Swapped the pip install -r requirements.txt block for uvx/uv run, and the lint/pre-commit lines now use uvx ruff … and uvx pre-commit …. Added a one-liner noting the project is uv-managed (pyproject.toml/uv.lock, no requirements.txt) so future agents don't reach for pip.

@algorithms-keeper algorithms-keeper Bot removed the awaiting reviews This PR is ready to be reviewed label Aug 30, 2026
@cclauss
cclauss merged commit 72d2eec into TheAlgorithms:master Aug 30, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation This PR modified documentation files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants