Skip to content

Commit b18cfff

Browse files
docs(README): Add instructions for i18n comments, rephrase part about on editing contributions.
1 parent 3c40994 commit b18cfff

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

Diff for: README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,9 @@ the categories in this file. Below are some general guidelines:
6969
- In contrast, some strings are common to multiple components,
7070
so it makes sense to group them by theme (e.g. accessModes) under the `common` category.
7171

72-
Note: Do not put comments in the YML files. They will be removed by `yaml-sort`!
72+
Note: Do not put comments in the YML files! They will be removed by `yaml-sort`.
73+
Instead, comments for other developers should be placed in the corresponding js/jsx/ts/tsx file.
74+
Comments for translators should be entered into Weblate (see [Contributing Translations](#contributing-translations))
7375

7476
### Internationalizable content in the configuration file
7577

@@ -111,7 +113,7 @@ OTP-react-redux now uses [Hosted Weblate](https://www.weblate.org) to manage tra
111113
Translations from the community are welcome and very much appreciated,
112114
please see instructions at https://hosted.weblate.org/projects/otp-react-redux/.
113115
Community input from Weblate will appear as pull requests with changes to files in the `i18n` folder for our review.
114-
(We reserve the right to edit or reject contributions as we see fit.)
116+
(Contributions may be edited or rejected to remain in line with long-term project goals.)
115117

116118
If changes to a specific language file is needed but not enabled in Weblate, please open an issue or a pull request with the changes needed.
117119

0 commit comments

Comments
 (0)