Repository navigation
docs: add AGENTS.md entry file for coding agents and contributors - #123
Open
ShryukGrandhi wants to merge 1 commit into
Open
ShryukGrandhi wants to merge 1 commit into
ShryukGrandhi wants to merge 1 commit into
Conversation
Signed-off-by: ShryukGrandhi <85529990+ShryukGrandhi@users.noreply.github.com>
This branch has not been deployed
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
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.
Summary
Adds a short
AGENTS.mdat the repo root as a single entry point for coding agents and new contributors. It covers:python -m pytestsuite called out as the merge gatelettucedect-model slug prefix, thetransformers<5requirement for EuroBERT, code style conventionsThe file is 43 lines. CONTRIBUTING.md now links to it near the top.
Notes:
.gitignorelistedAGENTS.mdunder "local scratch / personal working files" (d561d0f), so the file could not be tracked. I removed that one line.CLAUDE.mdand.claude/are still ignored. No agent-specific files are tracked in the repo, so none needed to become pointers.Related issue
Fixes #104
Type of change
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)Checklist
Rights & sign-off (required)
distributed under the repository's MIT license
(see CONTRIBUTING).