Skip to content

AGENTS.md

Latest commit

 

History

History
150 lines (135 loc) · 8.71 KB

AGENTS.md

File metadata and controls

150 lines (135 loc) · 8.71 KB
Raw

Agent Instructions

Licensing policy (read this first)

  • This is the most important policy in this repository. LibreYOLO's entire value is being genuinely MIT; one license violation endangers the project.
  • LibreYOLO faithfully respects open-source licenses.
  • Agents must not copy, adapt, paraphrase, or derive code from any third-party project unless that project is explicitly licensed under MIT, Apache-2.0, BSD, or a similarly permissive license compatible with LibreYOLO's licensing requirements. Unknown or missing license means incompatible.
  • Never rewrite, rename, or restructure incompatibly-licensed code to obscure its origin. A GPL function with new variable names is still a derivative work. The only acceptable remedies are re-derivation from a genuinely clean source with documented provenance, or removal. That choice belongs to the maintainer: surface it, never pick silently.
  • If an agent may have been exposed to, influenced by, or contaminated by code under GPL, AGPL, LGPL, proprietary, unknown, or otherwise incompatible terms, the agent must immediately stop work on the affected area, flag the contamination risk to the developer, and avoid contributing the affected code. Flagging is never the wrong move; quiet contribution always is.
  • Ported or adapted code must state its upstream: repository, commit, and license, in the PR description and the notice files.
  • These rules are about code only. Weights may carry any upstream license, including non-commercial (CC-BY-NC, FLUX non-commercial, DINOv3, and so on); a weight license is never a reason to block, gate, or avoid porting a model. Audit code provenance; for weights, ship the upstream license with them the way the license-audit skill says (license text and card notices when LibreYOLO hosts them) and move on. The one weight check that stops a hosted upload is terms that forbid redistribution.
  • See skills/libreyolo-license-audit/ for the audit discipline and the notice surfaces.

Agent conduct

  • Agents must not open GitHub issues.
  • Agents may open pull requests against any branch, including the dev to release PR that cuts a version. The description must follow .github/pull_request_template.md, which means a ## Code provenance section that is accurate for the actual diff; the rest of the template is guidance, so fill in what the change warrants (see also the merge-to-dev and libreyolo-release skills). A release PR must additionally say that it shows no CI checks by design and must be merged with a merge commit rather than a squash. Opening a PR is where an agent's authority stops: it does not approve, does not merge, and does not dismiss review findings.
  • Agents must not post issue comments or PR comments unless a human explicitly asks for it. This holds on the agent's own PR too: address review findings by pushing a commit, and put anything else in the summary to the human.
  • Humans handle issue creation, review submission, and final merge decisions.
  • Handing over a one-click pre-filled GitHub URL instead of opening the PR remains a valid option, and is the better one when the work is exploratory or the human wants the description in their own words. For an issue, which an agent still may not open, the libreyolo-report-issue skill produces that pre-filled link.
  • When possible, work in git worktrees
  • release is the default branch that visitors land on and clone; dev is the integration branch where all development lands before it is promoted to a release.

Reporting problems upstream

  • For the project's benefit, agents should offer to report anything weird they hit while working with the library: errors and crashes, weights that fail to download or load, tasks that took real struggle because documentation was missing or wrong, and code bugs discovered along the way.
  • Use skills/libreyolo-report-issue/ for this: it drafts an anonymized issue and hands the user a pre-filled GitHub URL to submit with one click, so the "agents do not open issues" rule stays intact while the signal still reaches the maintainers.

Commit policy

  • Do not add LLMs or agent tools as co-authors in commits.
  • Keep commit messages short and factual.
  • Avoid pushing docs, artifacts, helper scripts, or anything that should not go into the upstream LibreYOLO library

Documentation

  • Contributor-facing policy lives in CONTRIBUTING.md.
  • Exceptionally important schemas and contracts such as the checkpoint metadata standard live under /docs in the libreyolo repository. They are short and factual.
  • /docs/checkpoint_schema.md documents checkpoint metadata rules used for loading, identifying, and validating model checkpoints.
  • /docs/nomenclature.md documents canonical model names, filename rules, family/size/task conventions, and task-resolution behavior.
  • /docs/testing.md documents test tiers, CI expectations, smoke tests, nightly tests, and manual validation policy.
  • /docs/adr/ documents architecture decisions and design contracts.

README policy

  • README.md is the project's landing page: the first five minutes a developer spends on LibreYOLO, and the most important five minutes the project gets. Treat it as a high-stakes surface, not routine documentation.
  • Do not modify README.md or README.zh-CN.md a priori. The only unprompted reason to propose a change is a real error or inconsistency with the code, and even then: propose the exact diff to the user and get approval before landing it.
  • Never add new sections, restructure, or grow the README without an explicit user request. It balances being a landing page against being documentation; depth belongs in /docs or on the website.
  • One sanctioned exception: when a new model family lands, adding its single row to the existing family support table is expected. One row, in the existing table, and nothing else; only tick export columns that were actually run.
  • Style: no em dashes, no decorative or AI-flavored characters, no fluff.
  • The detailed editing contract lives in skills/libreyolo-update-readme/.

Review guidelines

  • These guidelines apply to agents performing PR reviews, not agents implementing code changes.
  • PR-review agents must read REVIEW.md before reviewing pull requests.
  • Treat REVIEW.md as repository context for scope, contracts, and common regression risks.
  • If a PR conflicts with REVIEW.md, flag the conflict with concrete file evidence.

Pull Request (PR) policy

  • Before opening a PR, and before pushing further changes to it, run greptile review --agent --branch <target-branch> when the Greptile CLI is available, and fix the valid findings first so the PR opens clean.
  • All development PRs target dev, never release. This holds regardless of which branch GitHub shows as the default: release is the public default branch, but it only receives curated release merges, not feature PRs.
  • Before reviewing or changing PRs, read the relevant files under /docs, especially documented schemas, contracts, and architecture decisions.
  • Prefer one PR per problem, or per small group of tightly related problems.
  • When debugging a specific model or issue, avoid changing global behavior or shared code unless the shared change is genuinely necessary.
  • Shared-code changes are allowed when they are the clean software engineering solution, but the PR must explain why the shared change is necessary and what other models or workflows it may affect.
  • Keep PRs to the least code needed to solve the stated problem.
  • Do not mention other computer vision libraries in PR titles or descriptions unless the comparison is necessary to explain compatibility or API behavior.
  • Agent-written PR descriptions are short and factual. Bullets, not prose. What changed, why, what the reviewer should check, what was not verified. No narration of the agent's process, no restating of its own reasoning, no adjectives, no selling. Ten lines beats fifty. A human who wants the longer story will ask for it or write it themselves.
  • The required ## Code provenance section must be accurate for the actual diff, never a placeholder, or the provenance-check CI gate fails.
  • An agent that opens a PR says so in one line, and states what it verified and what it did not. It never implies review or approval it does not have.

General library constraints

  • User-facing workflows must be directly callable. Document validation evidence and known limits separately; do not make acknowledgement flags the public capability contract.
  • Generally every user facing API (Python, yamls, etc) has to follow the de-facto YOLO CLI/API conventions
  • The Flagship models of LibreYOLO are YOLO9 (CNNs) and RF-DETR (transformers), and new features have to at least cover this two