Skip to content

docs: add maintainers section to README - #195

Open
helizaga wants to merge 1 commit into
mainfrom
tommy/docs-readme-maintainers
Open

docs: add maintainers section to README#195
helizaga wants to merge 1 commit into
mainfrom
tommy/docs-readme-maintainers

Conversation

@helizaga

@helizaga helizaga commented Aug 27, 2026

Copy link
Copy Markdown
Member

Adds a Maintainers section to the README, between Contributing and License.

Why

The repository has a CODEOWNERS entry, but nothing in the README or CONTRIBUTING.md says 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

  • Markdown renders correctly in the GitHub preview.
  • Both links verified to return 200: the maintainer profile and the contributors graph.
  • No shell files touched, so the ShellCheck lint job is unaffected.

Summary by CodeRabbit

  • Documentation
    • Added a Maintainers section to the README.
    • Included credits for project creators, maintainers, and external contributors.
    • Added a link to the full contributor list.

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.
@coderabbitai

coderabbitai Bot commented Aug 27, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 48fcd9a5-da93-43d3-b074-52003dc712e1

📥 Commits

Reviewing files that changed from the base of the PR and between c319233 and b0ac363.

📒 Files selected for processing (1)
  • README.md

Included review availability: Your plan provides up to 100 included reviews per hour; 98 remain after this review.


Walkthrough

README.md now includes a Maintainers section. The section credits the project creator, maintainers, and external contributors. It also links to the repository contributor list.

Changes

Maintainers Documentation

Layer / File(s) Summary
Add Maintainers section
README.md
The README identifies the project creator and acknowledges external contributors. It links to the repository contributor list.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to b0ac3

This documentation-only change adds maintainer and contributor links without affecting product behavior or production operation; no actionable merge-blocking risk remains.

Suggested reviewers: averyjennings, natoboram, scarf005

Poem

A rabbit checks the README with care
New maintainer credits bloom there
Contributors hop into view
A link points to the list anew
The burrow applauds the update flair

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the documentation change: adding a Maintainers section to the README.
Docstring Coverage ✅ Passed 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…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

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)
  • Create PR with unit tests
  • Commit unit tests in branch tommy/docs-readme-maintainers

Comment @coderabbitai help to get the list of available commands.

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.

1 participant