style-guide.md

Universal 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.

Heading IDs

All headings have explicit IDs like this:

## Try React {#try-react}

Do not translate these IDs! They are used for navigation and will break if the document is referred to externally, i.e.:

See the [beginning section](/getting-started#try-react) for more information.

✅ DO:

## Prueba React {#try-react}

❌ DON'T:

## Prueba React {#prueba-react}

This will break the link above.

Text in Code Blocks

Leave text in code blocks untranslated except for comments. You may optionally translate text in strings, but be careful not to translate strings that refer to code!

Example:

// Example
const element = <h1>Hello, world</h1>;
ReactDOM.render(element, document.getElementById('root'));

✅ DO:

// Ejemplo
const element = <h1>Hello, world</h1>;
ReactDOM.render(element, document.getElementById('root'));

✅ ALSO OKAY:

// Ejemplo
const element = <h1>Hola mundo</h1>;
ReactDOM.render(element, document.getElementById('root'));

❌ DON'T:

// Ejemplo
const element = <h1>Hola mundo</h1>;
// "root" refers to an element ID.
// DO NOT TRANSLATE
ReactDOM.render(element, document.getElementById('raíz'));

❌ DEFINITELY DON'T:

// Ejemplo
const elemento = <h1>Hola mundo</h1>;
ReactDOM.hacer(elemento, documento.obtenerElementoPorId('raíz'));

External Links

If an external link is to an article in a reference like MDN or Wikipedia, and a version of that article exists in your language that is of decent quality, consider linking to that version instead.

Example:

React elements are [immutable](https://en.wikipedia.org/wiki/Immutable_object).

✅ OK:

Los elementos de React son [inmutables](https://es.wikipedia.org/wiki/Objeto_inmutable).

For links that have no equivalent (Stack Overflow, YouTube videos, etc.), just use the English link.