Skip to content

Conversation

@TRC-Loop
Copy link

I'm a native german speaker so i translated the README into german for other german developers.

I've also added Links in all the other READMEs and ran dev.py format.

@TRC-Loop TRC-Loop requested a review from a team as a code owner December 16, 2025 20:06
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 16, 2025

📝 Walkthrough

Walkthrough

Added a new German README and updated the main README plus all localized README files to include a "Deutsch" link and a cross-reference anchor pointing to the new document.

Changes

Cohort / File(s) Summary
Main README update
README.rst
Inserted Deutsch into the English README language list and added cross-reference anchor .. _Deutsch: ./docs/readmes/README.de.rst.
New German README
docs/readmes/README.de.rst
Added new German README with translated content (installation, platform notes, build-from-source, contribution, license, dependencies, links, badges).
Localized README updates
docs/readmes/*
docs/readmes/README.es.rst, docs/readmes/README.fa.rst, docs/readmes/README.fr.rst, docs/readmes/README.gr.rst, docs/readmes/README.it.rst, docs/readmes/README.ja.rst, docs/readmes/README.pt-br.rst, docs/readmes/README.ru.rst, docs/readmes/README.zh-cn.rst, docs/readmes/README.zh-tw.rst
Added Deutsch to each language listing and appended/updated the anchor .. _Deutsch: README.de.rst for navigation (documentation/link updates only).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • oddbookworm
  • ankith26

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title 'Translated README into German' accurately describes the main change: adding a German translation of the README file.
Description check ✅ Passed The description is related to the changeset, explaining that the author translated the README into German and added links in all other READMEs.
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

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 35c1989 and 780484f.

📒 Files selected for processing (1)
  • docs/readmes/README.de.rst
🧰 Additional context used
🧠 Learnings (5)
📓 Common learnings
Learnt from: oddbookworm
Repo: pygame-community/pygame-ce PR: 0
File: :0-0
Timestamp: 2025-11-03T19:49:28.177Z
Learning: For translation pull requests in the pygame-ce repository: Focus only on verifying direct translation accuracy from the English source. Do not suggest new content or enhancements during translation PRs. New content should be added to the English version first in a separate pull request.
Learnt from: oddbookworm
Repo: pygame-community/pygame-ce PR: 0
File: :0-0
Timestamp: 2025-11-03T19:52:35.950Z
Learning: In translation PRs for the pygame-ce repository: When identifying potential new content or enhancements, ask the user if they want an issue opened to track adding the content to the English version first, rather than suggesting it directly in the translation PR.
Learnt from: damusss
Repo: pygame-community/pygame-ce PR: 3604
File: buildconfig/stubs/pygame/surface.pyi:298-299
Timestamp: 2025-10-11T10:24:52.717Z
Learning: For the pygame-community/pygame-ce repository, batch similar documentation or terminology improvements together in a single comment rather than pointing them out individually. This helps avoid unnecessary commit spam.
📚 Learning: 2025-10-08T08:15:01.411Z
Learnt from: ankith26
Repo: pygame-community/pygame-ce PR: 3602
File: buildconfig/stubs/pygame/locals.pyi:601-1198
Timestamp: 2025-10-08T08:15:01.411Z
Learning: The repository pygame-community/pygame-ce is for pygame-ce (pygame community edition), not the original pygame project. Always refer to it as pygame-ce in reviews and analyses.

Applied to files:

  • docs/readmes/README.de.rst
📚 Learning: 2025-11-03T19:52:35.950Z
Learnt from: oddbookworm
Repo: pygame-community/pygame-ce PR: 0
File: :0-0
Timestamp: 2025-11-03T19:52:35.950Z
Learning: In translation PRs for the pygame-ce repository: When identifying potential new content or enhancements, ask the user if they want an issue opened to track adding the content to the English version first, rather than suggesting it directly in the translation PR.

Applied to files:

  • docs/readmes/README.de.rst
📚 Learning: 2025-11-03T19:49:28.177Z
Learnt from: oddbookworm
Repo: pygame-community/pygame-ce PR: 0
File: :0-0
Timestamp: 2025-11-03T19:49:28.177Z
Learning: For translation pull requests in the pygame-ce repository: Focus only on verifying direct translation accuracy from the English source. Do not suggest new content or enhancements during translation PRs. New content should be added to the English version first in a separate pull request.

Applied to files:

  • docs/readmes/README.de.rst
📚 Learning: 2025-10-11T10:24:52.717Z
Learnt from: damusss
Repo: pygame-community/pygame-ce PR: 3604
File: buildconfig/stubs/pygame/surface.pyi:298-299
Timestamp: 2025-10-11T10:24:52.717Z
Learning: For the pygame-community/pygame-ce repository, batch similar documentation or terminology improvements together in a single comment rather than pointing them out individually. This helps avoid unnecessary commit spam.

Applied to files:

  • docs/readmes/README.de.rst
🔇 Additional comments (2)
docs/readmes/README.de.rst (2)

14-26: German translation is natural, well-written, and well-structured.

The translation demonstrates good localization practices with appropriate terminology choices (e.g., "Edition" vs. "Distribution" at line 20), natural tone adjustments for readability, and consistent translation of technical terms throughout. The structure mirrors the English README logically, with clear sections for installation, help, compilation, acknowledgments, dependencies, and contribution guidelines. Past feedback on tone and terminology has been well-incorporated.

Also applies to: 28-28, 84-102, 120-175, 177-239, 202-218


284-284: All language links in the German README translation are correctly configured and resolve properly. The English link path ./../../README.rst at line 284 correctly reaches the root README.rst, and all other language files referenced in lines 274–283 (README.zh-cn.rst through README.pt-br.rst) exist in the docs/readmes/ directory. No changes needed.


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.

@AntonisDevStuff
Copy link
Contributor

AntonisDevStuff commented Dec 16, 2025

The links from the German README to other languages are invalid, and the English reference README is missing.

@TRC-Loop
Copy link
Author

Should be fixed.

@aatle aatle added the docs label Dec 18, 2025
Copy link
Member

@ankith26 ankith26 left a comment

Choose a reason for hiding this comment

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

Thanks for contributing to pygame-ce! 🎉

Left minor reviews for your consideration.

Moved 'Deutsch' to the end and added 'English' at the start of the language list in the German README for consistency with other translations.
@TRC-Loop
Copy link
Author

That should be the polish! (:

Copy link
Member

@ankith26 ankith26 left a comment

Choose a reason for hiding this comment

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

I don't read german but I passed this though an LLM and it didn't flag any major issues so this PR LGTM, thanks 🎉

Copy link
Member

@Mega-JC Mega-JC left a comment

Choose a reason for hiding this comment

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

Thanks for working on this @TRC-Loop !

I'm also a fluent German speaker, and wanted to give you permission to make the overall translation read more natural. The current 1:1 translation is sacrificing scannability for accuracy - my review suggestions show examples of where it happens.

Since a lot of pygame users are on the younger side, it's best to keep the German README language as inviting as it was in the English version, even while using a formal tone.

@TRC-Loop
Copy link
Author

Done! It should be easier to understand for younger people. Thank you!

Copy link
Member

@Mega-JC Mega-JC left a comment

Choose a reason for hiding this comment

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

Thanks, this feels less heavy to read now. LGTM 🎊

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.

5 participants