docs: add maintainers section to README - #195
Conversation
The repository has a CODEOWNERS entry but nothing in the README identifies who maintains the project, so anyone landing on it has to check the contributors graph to find out. Also links the contributor list, since much of the adapter, platform and shell-integration surface came from outside contributions.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 100 included reviews per hour; 98 remain after this review. WalkthroughREADME.md now includes a Maintainers section. The section credits the project creator, maintainers, and external contributors. It also links to the repository contributor list. ChangesMaintainers Documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to This documentation-only change adds maintainer and contributor links without affecting product behavior or production operation; no actionable merge-blocking risk remains. Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.) ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Adds a Maintainers section to the README, between Contributing and License.
Why
The repository has a
CODEOWNERSentry, but nothing in the README orCONTRIBUTING.mdsays who maintains the project. Anyone landing on the repo has to open the contributors graph to find out — which is a strange gap for a project with 1.7k stars and 30+ outside contributors.The section also links the contributor list. Most of what gtr supports today came from outside contributions — editor and AI tool adapters, platform fixes, shell integrations, docs — and that is worth pointing at from the README rather than leaving it to the graph.
Changes
Docs only. No code, no behavior change, 9 lines added to
README.md.Testing
Summary by CodeRabbit