Skip to content

Move Credits section in the README.rst to docs/LEGACY_CREDITS.rst - #3709

Merged
damusss merged 1 commit into
pygame-community:mainfrom
Matiiss:matiiss-move-ancient-credits-to-docs
Feb 15, 2026
Merged

damusss merged 1 commit into
pygame-community:mainfrom
Matiiss:matiiss-move-ancient-credits-to-docs

Conversation

@Matiiss

@Matiiss Matiiss commented Feb 9, 2026

Copy link
Copy Markdown
Member

These credits are very very old and don't get updated and probably never will get updated.
They also take up a significant portion of the README.

@Matiiss
Matiiss requested a review from a team as a code owner February 9, 2026 05:26
@coderabbitai

coderabbitai Bot commented Feb 9, 2026 •

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

Credits and acknowledgments have been moved from README.rst to a new docs/LEGACY_CREDITS.rst file. A Dependencies section documenting version requirements for CPython, SDL, SDL_mixer, SDL_image, and SDL_ttf has been added to README.rst.

Changes

Cohort / File(s) Summary
README Documentation Restructuring
README.rst
Removed Credits/acknowledgments section (57 lines) and two legacy documentation anchor references. Added a new Dependencies block with tabular version requirements for CPython and SDL libraries.
Legacy Credits Documentation
docs/LEGACY_CREDITS.rst
New file containing relocated credits and acknowledgments with multiple contributor sections, including patch submitters, documentation contributors, and community acknowledgments with reStructuredText hyperlink targets.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: moving the Credits section from README.rst to docs/LEGACY_CREDITS.rst, which matches the file modifications shown in the changeset.
Description check ✅ Passed The description is directly related to the changeset, explaining the rationale for moving credits (they are old and take up significant README space) which aligns with the changes made.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments
docs/LEGACY_CREDITS.rst (1)

42-49: Batch doc wording/grammar polish (optional).

A few phrases read awkwardly (“There’s many…”, “Many thank you’s…”, “thanks for people creating games…”). Consider a small wording pass to tighten grammar and flow in this paragraph group.

💡 Example phrasing (batched)
-There's many more folks out there who've submitted helpful ideas, kept
+There are many more folks out there who've submitted helpful ideas, kept
 this project going, and basically made our life easier.  Thanks!

-Many thank you's for people making documentation comments, and adding to the
+Many thanks to people making documentation comments, and adding to the
 `pygame documentation`_ and the `pygame-ce documentation`_.

-Also many thanks for people creating games and putting them on the
+Also many thanks to people creating games and putting them on the
 pygame.org website for others to learn from and enjoy.

Based on learnings: “For the pygame-community/pygame-ce repository, batch similar documentation or terminology improvements together in a single comment rather than pointing them out individually.”


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.

@Matiiss Matiiss changed the title Move Credits section in the README to docs/LEGACY_CREDITS.rst Move Credits section in the README.rst to docs/LEGACY_CREDITS.rst Feb 9, 2026
@damusss

damusss commented Feb 12, 2026

Copy link
Copy Markdown
Member

What about the credits in different languages of the README?

@damusss damusss added the docs label Feb 12, 2026

@Starbuck5 Starbuck5 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks!

I don't see translations as an issue @damusss, they're supposed to be updated by people who care about them and it's not a big deal if they still have this info.

@damusss

damusss commented Feb 15, 2026

Copy link
Copy Markdown
Member

@Starbuck5 makes sense, and I suppose since they're legacy anyways it's not an issue if they're only available in English.

@damusss damusss left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

(see comment above)
Thanks matiiss

@damusss
damusss merged commit d1460b0 into pygame-community:main Feb 15, 2026
13 checks passed
@ankith26 ankith26 added this to the 2.5.7 milestone Mar 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants