feat: let agents.yml override the GitHub repo description

This commit is contained in:
tiennm99 committed 2026-09-29 13:08:18 +07:00
1 parent 14a013a151
commit ebe7bce900
7 files changed
+88 -3

No files matched your search

+12 -1
View File
@@ -8,12 +8,13 @@ Edit [`data/agents.yml`](../data/agents.yml) and add an entry:
agents:
- owner: github-username-or-org
repo: repository-name
description: Terminal coding agent that edits files and runs commands in your repo
tags: [terminal, byo-model, interactive, community]
```
Required fields: `owner`, `repo`, `tags`
Optional fields: `notes` (for clarifications or caveats)
Optional fields: `description` (curated one-liner), `notes` (for clarifications or caveats)
## Field Reference
@@ -22,8 +23,18 @@ Optional fields: `notes` (for clarifications or caveats)
| `owner` | string | Yes | GitHub user or organization that owns the repo |
| `repo` | string | Yes | Repository name on GitHub |
| `tags` | list | Yes | Tags from the vocabulary below; at least one surface tag, at most one origin tag |
| `description` | string | No | Curated one-line description shown instead of the repo's GitHub description; one line, no `\|`, at most 140 characters |
| `notes` | string | No | Additional context or disclaimers |
### Writing a description
Say what the tool is (terminal agent, VS Code extension, editor, desktop app,
self-hosted server) and the one trait that sets it apart, in one plain sentence
with no trailing period. Base it on the repo's own README, like tags. Leave out
marketing adjectives, emoji, star counts, and model version names, which go
stale within months. Without a `description`, the README shows whatever the
repo's GitHub description says, which is often empty or vague.
## Scope
This list ranks **developer tools built around AI** — things a developer uses to