Skip to content

docs: add contributors section to README - #434

Merged
jeff-r2026 merged 1 commit into
Tencent:mainfrom
jeff-r2026:docs/readme-contributors
Sep 8, 2026
Merged

docs: add contributors section to README#434
jeff-r2026 merged 1 commit into
Tencent:mainfrom
jeff-r2026:docs/readme-contributors

Conversation

@jeff-r2026

Copy link
Copy Markdown
Collaborator

What

Add a Contributors section at the end of both READMEs (README.md / README.zh-CN.md), right after Contributing.

Uses the contrib.rocks dynamic avatar image, so no contributor list needs to be maintained by hand — new contributors show up automatically.

<a href="https://github.com/Tencent/teamai-cli/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=Tencent/teamai-cli" alt="Contributors" />
</a>

Why

Give visible credit to everyone who has contributed, and make the contributors graph one click away from the README.

Test Plan

Docs-only change; no CLI behavior is affected, so no build or end-to-end run applies.

  • Verified the image endpoint actually resolves: curl -sS -o /dev/null -w "%{http_code} %{content_type}" "https://contrib.rocks/image?repo=Tencent/teamai-cli"200 image/svg+xml
  • Inspected the returned SVG: 812x200, contains 28 embedded contributor avatars
  • Both language READMEs updated in sync, with localized wording in the Chinese version
  • Single commit, only README.md and README.zh-CN.md touched

Note

contrib.rocks is cached by its own CDN and by GitHub's camo proxy, so newly merged contributors can take hours to appear. If instant accuracy matters more than zero maintenance, a scheduled action such as contributors-readme-action that writes a real table into the README would be the alternative.

Made with Cursor

Co-authored-by: Cursor <cursoragent@cursor.com>
@jeff-r2026
jeff-r2026 merged commit e0dae66 into Tencent:main Sep 8, 2026
5 checks passed
@jeff-r2026
jeff-r2026 deleted the docs/readme-contributors branch September 8, 2026 08:18
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