Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Best process for making corrections across languages? #3386

Open
bambery opened this issue Jan 13, 2024 · 1 comment
Open

Best process for making corrections across languages? #3386

bambery opened this issue Jan 13, 2024 · 1 comment

Comments

@bambery
Copy link
Contributor

bambery commented Jan 13, 2024

I try to create PRs when there are simple corrections to be made in course content. Sometimes these corrections are for English grammar, but sometimes the corrections are regarding code or outdated links. For example, I recently submitted PR #3385 to remove an outdated reference to create-react-app in section 7b. I checked the Suomi and Japanese versions, and they both contain this same reference, but I have only updated the English file.

My first question is this: what would be the best practice when it comes to making updates which are specifically about content like outdated references or old links? Should I make language-agnostic fixes in the other languages in the same PR? This question is specifically about making updates which have no language value, such as fixing links from old react docs to new react docs.

Second: sometimes, like with PR #3385, I was also required to make minor word adjustments to fit around the edit, and I can't guarantee my edits would make perfect sense in other languages. Are there maintainers for each language who, perhaps, I would be better off alerting to do the fixes themselves? Should I attempt to use a translation service to do my best?

Or should I just stick to making fixes in English?

@vimode
Copy link
Contributor

vimode commented Jan 18, 2024

Hey @bambery, let me start by saying I am not a maintainer. Just a contributor like you.

Since most of the translations are done by the community the other languages might not be maintained that well so I would recommend you to do language agnostic fixes in your PR for other languages too like fixing links, commands, code related updates.

Even if the text around the updated code is not updated, its better for the translated document be updated with the fixed commands, code and links which the reader can use and infer from.

If you need an example, here are some similar contributions I did in the past #2310 #2274.

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

No branches or pull requests

2 participants