From b362191966a78bc688db2ae0661c8a97c054ede8 Mon Sep 17 00:00:00 2001 From: Ilya Kantor Date: Thu, 11 Apr 2019 10:44:25 +0300 Subject: [PATCH] style --- style-guide.md | 79 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 style-guide.md diff --git a/style-guide.md b/style-guide.md new file mode 100644 index 00000000..276d8b9f --- /dev/null +++ b/style-guide.md @@ -0,0 +1,79 @@ +# Style Guide + +This document describes rules that should be applied to **all** languages. + +NOTE TO MAINTAINERS: You may want to translate this guide so that it can be more accessible to your translators. + +## General + +The translation doesn't have to be word-by-word precise. + +It should be technically correct and explain well. + +If you feel the original text could be improved, please send a PR. + +## Text in Code Blocks + +- Translate comments in code blocks. +- Translate example strings (optionally). +- Don't translate variable names, ids, classes. + +Example: + +```js +// Example +const text = "Hello, world"; +document.querySelector('.hello').innerHTML = text; +``` + +✅ DO (comment): + +```js +// Ejemplo +const text = 'Hello, world'; +document.querySelector('.hello').innerHTML = text; +``` + +✅ ALSO OKAY (also text): + +```js +// Ejemplo +const text = 'Hola mundo'; +document.querySelector('.hello').innerHTML = text; +``` + +❌ DON'T (class): + +```js +// Ejemplo +const text = 'Hola mundo'; +// ".hello" is a class +// DO NOT TRANSLATE +document.querySelector('.hola').innerHTML = text; +``` + +❌ DEFINITELY DON'T (variables): + +```js +// Ejemplo +const texto = 'Hola mundo'; +documento.querySelector('.hola').interiorHTML = texto; +``` + +## External Links + +If an external link is to Wikipedia, e.g. , and a version of that article exists in your language that is of decent quality, consider linking to that version instead. + +Example: + +```md +[JavaScript](https://en.wikipedia.org/wiki/JavaScript) is a programming language. +``` + +✅ OK: + +```md +[JavaScript](https://es.wikipedia.org/wiki/JavaScript) es un lenguaje de programación. +``` + +For links that have no equivalent, just use the English link.