Translation Guidelines for Developer Docs

developer_docs/README.md

@@ -6,6 +6,7 @@ This folder contains documents intended for developers of the p5.js Web Editor.
 * [Development](development.md) - A guide for adding code to the web editor
 * [Preparing a pull-request](preparing_a_pull_request.md) - Instructions for how to make a pull-request
 * [Accessibility Guidelines](accessibility.md) - Guidelines for writing code to create an accessible application
+* [Translations Guidelines](translations.md) - Guidelines for translating the application
 * [Deployment](deployment.md) - A guide to production deployment, and all platforms that are being used.
 * [Release](./release.md) - A guide to creating a production release.
 

developer_docs/translations.md

@@ -0,0 +1,53 @@
+## Translations Guidelines
+
+
+*How to contribute with Translations for p5 web editor*
+
+**General rules of thumb for translations**
+
+In order to simplify the translations process the following rules of thumb were used:
+
+**Technical Part**
+
+* There is only one file to translate all the texts in any specific language, which is located under the directory, in respective locale [subdirectory](https://github.com/processing/p5.js-web-editor/tree/develop/translations/locales)
+* The new language code must be added to [i18n.js](https://github.com/processing/p5.js-web-editor/blob/develop/client/i18n.js#L7)
+* New languages will need to be selected using a dropdown in Nav component, specifically in function [renderLanguageMenu.](https://github.com/processing/p5.js-web-editor/blob/develop/client/components/Nav.jsx#L550)
+
+**Translations**
+
+* Every component should introduce its own subset of keys inside a dictionary named after the component. 
+   For instance: If you want to translate AssetList.jsx you need to introduce the following namespace in translations.json :
+```
+ "AssetList": {
+    "Title": "p5.js Web Editor | My assets",
+    "ToggleOpenCloseARIA": "Toggle Open/Close Asset Options",
+    "OpenNewTab": "Open in New Tab",
+    "HeaderName": "Name",
+  }
+```
+* There are common texts that are present in Common namespace, try to check first if the exact label is already present there.
+* Every key follows PascalCase case style.
+* Every key that is used in an ARIA text should end with the suffix ‘ARIA’.
+* The order of keys inside of appearance should be order of in the order they appear in the source code
+
+**Language Use**
+
+The Processing Foundation is specifically invested in expanding the communities of technology and the arts to include and support those who have not had equal access because of their race, gender, class, sexuality, and/or disability. We see software as a medium, something that connects two things. We view it as a means for thinking and making. We believe software, and the tools to learn it, should be accessible to everyone
+
+With those principles in mind, we want to strongly suggest the use of non-gendered terms whenever possible. If it is not possible to avoid, use the most inclusive version. 
+For instance, in Spanish translation we tackled that problem with a particular rule of thumb:
+Avoid male-gendered words, use instead the letter ‘e’  , we used the ‘e’ approach vs other approaches like ‘x’ or ‘@’ because you also need to think about how screen readers would read the text aloud.
+
+**Discussion**
+
+Did you want to know the context?
+* The original idea for Alpha Editor in Spanish was addressed in [this issue](https://github.com/processing/p5.js-web-editor/issues/595)
+* The discussion regarding which library to use was addressed in [Library](https://github.com/processing/p5.js-web-editor/issues/1447)
+* [UI Design](https://github.com/processing/p5.js-web-editor/issues/1434)
+* [Language Use](https://github.com/processing/p5.js-web-editor/issues/1509) 
+
+
+
+Thanks! 
+P5.js Web Editor Community
+