Document tracker contribution flow#1148
Open
chrmod wants to merge 3 commits into
Open
Conversation
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. |
Member
Author
|
All good. Will adopt. |
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.
a384f28 to
ebaade8
Compare
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
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.mdwalks 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.mdat 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.add-tracker-domaintoresearch-tracker-domainand rescoped: it no longer writes files indb/. 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.mdlinks 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
docs/contributing.mdend-to-end and confirm a new contributor would have what they need to add a tracker.AGENTS.mdand confirm it gives a fresh contributor a clear next step.db/.