Skip to content

Commit

Permalink
(docs) Update translation/style-guide.md (#21570)
Browse files Browse the repository at this point in the history
* Update style-guide.md

* Update style-guide.md

* chore: format

Co-authored-by: GatsbyJS Bot <mathews.kyle+gatsbybot@gmail.com>
  • Loading branch information
tesseralis and GatsbyJS Bot authored Feb 19, 2020
1 parent 9b2d51b commit 8234336
Showing 1 changed file with 28 additions and 6 deletions.
34 changes: 28 additions & 6 deletions docs/contributing/translation/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,41 @@ Each language translation may have some specific ways it differs from the advice

Guidelines that remain firm no matter the language stem from the goals and values of Gatsby as a project: to provide a **friendly community for Gatsby learners of all skill and experience levels** that's also **safe and welcoming to contributors**. Translated docs and learning materials should [maintain these values](/blog/2019-04-19-gatsby-why-we-write/) with **high-quality spelling and grammar**, accurate information, similar structure and purpose. For any questions about guidelines, feel free to [get in touch](/contributing/how-to-contribute/#not-sure-how-to-start-contributing) with the Gatsby team.

### Glossary
## Glossary

The style guide has a [glossary section](https://github.com/gatsbyjs/gatsby-i18n-source/blob/master/style-guide.md#glossary) that you can use to fill in common translations. Look at the English [Glossary](/docs/glossary/) for a list of terms that are useful to have translations for.

### Universal style guide
## Universal style guide

The following rules should apply in all translations and can serve as a basis for your language-specific style guide.

#### Keep the meaning of the source
### Keep the meaning of the source

Keep the meaning of the original English source even if it is confusing or has a typo. If you find an error that can be fixed, create an issue or pull request to the original [gatsby repo](https://github.com/gatsbyjs/gatsby) so that all translations can benefit from the change.

#### Text in code blocks
### Use soft line wraps

Use soft line wraps for paragraphs:

✅ DO:

```md
No intuito de promover um ambiente aberto e acolhedor, nós, como contribuidores e mantenedores, nos comprometemos em tornar a participação em nossos projetos e em nossa comunidade o mais livre de assédio para todos, independentemente da idade, corpo, tamanho, deficiência, etnia, identidade ou expressão de gênero, nível de experiência, nacionalidade, aparência, raça, religião ou identidade e orientação sexual.
```

❌ DON'T:

```md
No intuito de promover um ambiente aberto e acolhedor, nós, como contribuidores e mantenedores,
nos comprometemos em tornar a participação em nossos projetos e em nossa comunidade o mais livre
de assédio para todos, independentemente da idade, corpo, tamanho, deficiência, etnia, identidade
ou expressão de gênero, nível de experiência, nacionalidade, aparência, raça, religião ou identidade
e orientação sexual.
```

Using soft line wraps ensures that paragraphs are always matched with the original source paragraphs when syncing, and prevents weird errors with mismatched lines.

### 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!

Expand Down Expand Up @@ -62,7 +84,7 @@ exportar defecto () => (
)
```

#### Internal links
### Internal links

Translate link text but keep all slugs and hashes in links the same as they are in English.

Expand All @@ -78,7 +100,7 @@ Translate link text but keep all slugs and hashes in links the same as they are
- [Configura tu entorno de desarrollo](/tutorial/configura-tu-entorno-de-desarrollo)
```

#### External links
### 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.

Expand Down

0 comments on commit 8234336

Please sign in to comment.