Skip to content

Document tracker contribution flow#1148

Open
chrmod wants to merge 3 commits into
mainfrom
add-tracker-domain-skill
Open

Document tracker contribution flow#1148
chrmod wants to merge 3 commits into
mainfrom
add-tracker-domain-skill

Conversation

@chrmod
Copy link
Copy Markdown
Member

@chrmod chrmod commented May 6, 2026

Summary

Move guidance on adding a new tracker into documentation that serves human contributors first and AI assistants by extension, so the dataset stays hand-curated rather than auto-generated.

  • docs/contributing.md walks contributors through adding a tracker: repository layout, file formats, slug conventions, choosing a category, when to add filters, sourcing expectations, how to reuse an existing organization, and how to avoid duplicates.
  • AGENTS.md at the repository root gives a brief orientation: what the project is, the curated-not-generated stance, the CI commands to run before opening a PR, and a pointer to the contributor guide.
  • The skill is renamed from add-tracker-domain to research-tracker-domain and rescoped: it no longer writes files in db/. Instead it produces a sourced research report (existing coverage, operator, suggested category, candidate organization to reuse, open questions) that a contributor reviews and turns into a PR.
  • README.md links to the new contributor guide.

This responds to review feedback that auto-generation tooling could send the wrong message about the data-quality bar — documentation is dual-use, and the helper now stays on the human's side of the loop.

Test plan

  • Read docs/contributing.md end-to-end and confirm a new contributor would have what they need to add a tracker.
  • Read AGENTS.md and confirm it gives a fresh contributor a clear next step.
  • Click through the internal links in both files and from the README and verify they all resolve.
  • Invoke the renamed skill on a sample domain and confirm the output is a research report — no files written under db/.

@philipp-classen
Copy link
Copy Markdown
Member

It is a big topic, but I feel it is not in the best interest of the project to add tooling for auto-generating changes. It can send the wrong message, since we do not want to attract generated pull requests, but push for a high quality, trusted data set.

My own view is closer to https://github.com/ggml-org/llama.cpp/blob/master/AGENTS.md

Overall, I see more value in traditional documentation. It is dual-use, since it serves humans, but AI agents can also read through it.

@chrmod
Copy link
Copy Markdown
Member Author

chrmod commented May 6, 2026

All good. Will adopt.

@chrmod chrmod changed the title Add Claude skill for onboarding new tracker domains Document tracker contribution flow May 6, 2026
Documents the flow for adding a tracker domain (file formats, slug
conventions, sourcing, duplicate avoidance) and ships a research skill
that gathers sourced facts about a domain into a proposal the
contributor reviews before any file is written.
@chrmod chrmod force-pushed the add-tracker-domain-skill branch from a384f28 to ebaade8 Compare May 7, 2026 10:56
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.

2 participants