style-guide.md

Style Guide

Ten dokument zawiera zasady specyfyczne dla języka, których należy przestrzegać podczas tłumaczenia.

Zasady

Tekst w Blokach Kodu

Tekst w blokach kodu, z wyjątkiem komentarzy, nie powinien być tłumaczony. Opcjonalnie możesz przetłumaczyć łańcuchy znaków, ale uważaj, aby nie odnosiły się one do kodu!

Przykład:

// Example
import React from "react"
export default () => (
  <div style={{ color: `purple`, fontSize: `72px` }}>Hello Gatsby!</div>
)

✅ DOBRZE:

// Przykład
import React from "react"
export default () => (
  <div style={{ color: `purple`, fontSize: `72px` }}>Hello Gatsby!</div>
)

✅ RÓWNIEŻ DOBRZE:

// Przykład
import React from "react"
export default () => (
  <div style={{ color: `purple`, fontSize: `72px` }}>Witaj, Gatsby!</div>
)

❌ ŹLE:

// Przykład
import React from "react"
export default () => (
  // 'purple' jest słowem kluczowym CSS
  <div style={{ color: `fioletowy`, fontSize: `72px` }}>Witaj, Gatsby!</div>
)

❌ ZDECYDOWANIE ŹLE:

importuj React z "react"
eksportuj domyślnie () => (
   <div styl={{ kolor: `fioletowy`, fontSize:` 72px` }}>Witaj, Gatsby!</div>
)

Zewnętrzne Linki

Jeśli zewnętrzny link prowadzi do artykułu w np. MDN lub Wikipedia, a istnieje jego dobrze przetłumaczona wersja, weź pod uwagę, czy nie lepiej byłoby użyć jej.

Przykład:

React is a JavaScript [library](<https://en.wikipedia.org/wiki/Library_(computing)>).

✅ DOBRZE:

React jest javascriptową [biblioteką](https://pl.wikipedia.org/wiki/Biblioteka_programistyczna).

Dla linków, które nie mają polskiego odpowiednika (Stack Overflow, filmy na YouTube , itd.), po prostu użyj wersji angielskiej.

Odmiana nazwy

Wiele osób próbuje odmieniać nazwę Gatsby. Ustalono jednak, że w dokumentacji odmieniać tej nazwy nie będziemy. Czyli:

✅ DOBRZE:

Dokumentacja API motywów Gatsby.

❌ ŹLE:

Dokumentacja API motywów Gatsby'ego.

lub

✅ DOBRZE:

Praca z Gatsby.

❌ ŹLE:

Praca z Gatsby'm.

Słowniczek

Użyj tej sekcji, jako spisu tłumaczeń dla często używanych, technicznych pojęć.

Słowo / pojęcie	Tłumaczenie
Array	Array (odmieniany po polsku)
Development environment	Środowisko programistyczne
Development server	Serwer deweloperski
Explorer	Eksplorator
Gatsby Docs	Dokumentacja Gatsby (pisane z wielkiej litery)
Global styles	Style globalne
Layout components	Komponenty Układu
Node	Node (odmieniane po polsku)
Plugin	Wtyczka
Query	Zapytanie
Root	Katalog główny
Run command	Uruchom komendę
Scope	Zasięg
Selectors	Selektory
Source plugins	Wtyczki Źródeł
String	String (odmieniany po polsku)
Stylesheet	Arkusz stylów
Theme	Motyw
Transformer plugins	Wtyczki Transformacji
Tutorial	Samouczek lub Poradnik