Skip to content

Conversation

@dlhck
Copy link
Collaborator

@dlhck dlhck commented Nov 14, 2025

Description of change

Expanded sponsors section to show all four OpenCollective tiers:

  • Champion ($500/month) - premium support
  • Supporter ($20/month) - monthly contribution
  • Community ($5/month) - community tier
  • Sponsor (custom) - flexible amount

Removed outdated translation files (README_ko.md, README-zh_CN.md) - not maintained, not referenced in build/CI.

All widgets updated to use avatarHeight=36 parameter.

Pull-Request Checklist

  • Code is up-to-date with the master branch
  • This pull request links relevant issues as Fixes #00000 N/A
  • There are new or updated unit tests validating the change N/A
  • Documentation has been updated to reflect this change

Summary by CodeRabbit

Documentation

  • Removed Chinese language (zh_CN) documentation file
  • Removed Korean language (ko) documentation file
  • Restructured the Sponsors section in main documentation with new sponsor tiers including Champion, Supporter, Community, and Sponsor levels

@dlhck dlhck requested a review from michaelbromley November 14, 2025 10:03
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 14, 2025

Walkthrough

The pull request removes Chinese and Korean README translations entirely and restructures the English README's Sponsors section by replacing a single sponsor block with new tiered sponsor sections including Champion, Supporter, Community, and Sponsor categories.

Changes

Cohort / File(s) Summary
Documentation Deletions
README-zh_CN.md, README_ko.md
Removed entire Chinese and Korean language README files, including all localized documentation content, examples, guides, and references.
Sponsors Section Restructure
README.md
Replaced single sponsor block with structured sponsor tiers: added Champion tier with call-to-action and image, plus new Supporter, Community, and Sponsor sections with descriptive text and corresponding image blocks.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • No executable code or runtime behavior changes
  • All modifications are documentation-only (deletions and section restructuring)
  • No complex logic, dependencies, or public API alterations

Poem

🐰 The READMEs fade in eastern lands so bright,
While sponsors bloom in tiers of new delight!
Champions rise, supporters gather 'round,
Documentation grows, where care is found.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: expanding the sponsors section and removing outdated translation files (README-zh_CN.md and README_ko.md).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch update-readmes

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@dlhck dlhck requested review from alumni and pkuczynski November 14, 2025 10:03
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2681051 and 9cd2d2a.

📒 Files selected for processing (3)
  • README-zh_CN.md (0 hunks)
  • README.md (1 hunks)
  • README_ko.md (0 hunks)
💤 Files with no reviewable changes (2)
  • README-zh_CN.md
  • README_ko.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md

216-216: Images should have alternate text (alt text)

(MD045, no-alt-text)


222-222: Images should have alternate text (alt text)

(MD045, no-alt-text)


228-228: Images should have alternate text (alt text)

(MD045, no-alt-text)


234-234: Images should have alternate text (alt text)

(MD045, no-alt-text)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Cloudflare Pages
🔇 Additional comments (1)
README.md (1)

210-234: Well-structured sponsorship tiering system.

The new Sponsors section provides clear tier definitions with actionable CTAs for each sponsorship level. The consistent use of avatarHeight=36 across all OpenCollective widgets and the introductory text explaining the value proposition are both well-implemented.

Become a champion sponsor and get premium technical support from our core contributors. [Become a champion](https://opencollective.com/typeorm)

Become a gold sponsor and get premium technical support from our core contributors. [Become a gold sponsor](https://opencollective.com/typeorm)
<a href="https://opencollective.com/typeorm" target="_blank"><img src="https://opencollective.com/typeorm/tiers/gold-sponsor.svg?avatarHeight=36"></a>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Add alt text to sponsor tier images for accessibility.

The <img> tags lack alt attributes, which is an accessibility requirement for screen readers and is flagged by markdownlint (MD045).

Apply this diff to add descriptive alt text to each sponsor tier image:

-<a href="https://opencollective.com/typeorm" target="_blank"><img src="https://opencollective.com/typeorm/tiers/gold-sponsor.svg?avatarHeight=36"></a>
+<a href="https://opencollective.com/typeorm" target="_blank"><img src="https://opencollective.com/typeorm/tiers/gold-sponsor.svg?avatarHeight=36" alt="Champion sponsors on OpenCollective"></a>

-<a href="https://opencollective.com/typeorm" target="_blank"><img src="https://opencollective.com/typeorm/tiers/love.svg?avatarHeight=36"></a>
+<a href="https://opencollective.com/typeorm" target="_blank"><img src="https://opencollective.com/typeorm/tiers/love.svg?avatarHeight=36" alt="Supporter sponsors on OpenCollective"></a>

-<a href="https://opencollective.com/typeorm" target="_blank"><img src="https://opencollective.com/typeorm/tiers/like.svg?avatarHeight=36"></a>
+<a href="https://opencollective.com/typeorm" target="_blank"><img src="https://opencollective.com/typeorm/tiers/like.svg?avatarHeight=36" alt="Community sponsors on OpenCollective"></a>

-<a href="https://opencollective.com/typeorm" target="_blank"><img src="https://opencollective.com/typeorm/tiers/sponsor.svg?avatarHeight=36"></a>
+<a href="https://opencollective.com/typeorm" target="_blank"><img src="https://opencollective.com/typeorm/tiers/sponsor.svg?avatarHeight=36" alt="Sponsors on OpenCollective"></a>

Also applies to: 222-222, 228-228, 234-234

🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

216-216: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 Prompt for AI Agents
In README.md around line 216 (also apply same change at lines 222, 228, 234),
the sponsor tier <img> tags are missing alt attributes; update each <img> to
include descriptive alt text (e.g., alt="TypeORM gold sponsor" for the 216 line
and corresponding alt descriptions for the other sponsor tiers) so markdownlint
MD045 and accessibility requirements are satisfied.

Copy link
Collaborator

@gioboa gioboa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👏

@pkuczynski pkuczynski merged commit 6da0911 into master Nov 14, 2025
12 checks passed
@pkuczynski pkuczynski deleted the update-readmes branch November 14, 2025 11:16
ThbltLmr pushed a commit to ThbltLmr/typeorm that referenced this pull request Dec 2, 2025
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.

5 participants