Skip to content

docs: add AGENTS.md entry file for coding agents and contributors - #123

Open
ShryukGrandhi wants to merge 1 commit into
KRLabsOrg:mainfrom
ShryukGrandhi:fix/issue-104-add-agents-md-one-entry-file-for-coding
Open

ShryukGrandhi wants to merge 1 commit into
KRLabsOrg:mainfrom
ShryukGrandhi:fix/issue-104-add-agents-md-one-entry-file-for-coding

Conversation

@ShryukGrandhi

Copy link
Copy Markdown

Summary

Adds a short AGENTS.md at the repo root as a single entry point for coding agents and new contributors. It covers:

  • setup, lint and test commands (the same ones CI runs), with the network-free python -m pytest suite called out as the merge gate
  • a repository map: detectors, models, datasets, preprocess, prompts, integrations, CLI, API, scripts/docs
  • durable constraints: no network in unit tests, the lettucedect- model slug prefix, the transformers<5 requirement for EuroBERT, code style conventions
  • pointers to CONTRIBUTING.md, the PR template and CHANGELOG.md

The file is 43 lines. CONTRIBUTING.md now links to it near the top.

Notes:

  • .gitignore listed AGENTS.md under "local scratch / personal working files" (d561d0f), so the file could not be tracked. I removed that one line. CLAUDE.md and .claude/ are still ignored. No agent-specific files are tracked in the repo, so none needed to become pointers.
  • The issue mentions RELEASING.md, but that file doesn't exist yet, so AGENTS.md points to CHANGELOG.md instead. A link can be added once RELEASING.md lands.

Related issue

Fixes #104

Type of change

  • Bug fix
  • Feature
  • Documentation
  • Tests
  • Refactor or maintenance

Testing

Documentation only. No code changed.

  • ruff format --check lettucedetect/ lettucedetect_api/ tests/ (69 files already formatted)
  • ruff check lettucedetect/ lettucedetect_api/ tests/ --extend-exclude lettucedetect/integrations/ (all checks passed)
  • python -m pytest (207 passed)
  • Other: checked the paths, class names and model ids in AGENTS.md against the source tree

Checklist

  • I kept the PR focused on one change.
  • I added or updated tests/docs when needed.
  • I checked that no secrets, API keys, or credentials are included.

Rights & sign-off (required)

  • I certify that I have the right to submit this code and that it may be
    distributed under the repository's MIT license
    (see CONTRIBUTING).

Signed-off-by: ShryukGrandhi <85529990+ShryukGrandhi@users.noreply.github.com>

This branch has not been deployed

No deployments
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.

Add AGENTS.md: one entry file for coding agents and new contributors

1 participant