OpenTabletDriver / OpenTabletDriver/OpenTabletDriver

[Meta] Consider what to do with out of sync localized READMEs

Open
#3,596 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation localization meta
Dominant language
C#
Stars
4.1k
Forks
534
Avg merge
4d 20h
Merged PRs (30d)
12

Description

#3368 / #3390 moved 0.6.x to .NET 8.0, but remnants of .NET 6.0 can still be seen in some localized documentation:

https://github.com/OpenTabletDriver/OpenTabletDriver/blob/902d0d5873eed2e2a4cd882c43d5a723ea7a78e8/docs/README_KO.md?plain=1#L37-L39

(among others)

This is likely going to be a ongoing problem whenever README contents change.

While adjusting localized content is occasionally possible (especially when just numbers and URLs change, as seen in #3387), not everything can be updated by people not fluent in the language.

This means we either need to autogenerate localized READMEs (would have to check what other projects do), have a person responsible for localization in their respective language, or just put a "last modified" date at the top of the file? Other solutions are welcome too.

Alternatively we can get rid of the localized READMEs, but I prefer the positive social implications that having these do (both for contributors and users), so I would see that only as a last resort option.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing docs/README_KO.md and the related changes in #3368, #3390, and #3387, then inspect the other localized README files for similar drift. Compare the available maintenance approaches described in the issue and document a clear decision, scope, and completion criteria for keeping localized READMEs synchronized.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, localization
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.