Skip to content

Commit 8d6cef0

Browse files
committed
🎉 Initial Style Guide
1 parent 2d664c1 commit 8d6cef0

File tree

1 file changed

+112
-0
lines changed

1 file changed

+112
-0
lines changed

style-guide.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
# Univerzális stílus útmutató
2+
3+
## Fejléc azonosítók
4+
5+
Minden fejlécnek van egy saját azonosítója:
6+
7+
```md
8+
## Try React {#try-react}
9+
```
10+
11+
Ezeket az azonosítókat **ne** fordítsd le! Ezek a navigáció szempontjából fontosak, és ha megváltozank, a külső linkek nem fognak működni, azaz:
12+
13+
```md
14+
See the [beginning section](/getting-started#try-react) for more information.
15+
```
16+
17+
✅ TEDD:
18+
19+
```md
20+
## Próbáld ki a React-et {#try-react}
21+
```
22+
23+
❌ NE TEDD:
24+
25+
```md
26+
## Próbáld ki a React-et {#probald-ki-a-reactet}
27+
```
28+
29+
Ez elérhetetlenné teszi a fenti linket.
30+
31+
## Szöveg Kódblokkokban
32+
33+
A kódblokkokban lévő szövegeket - a kommentek, esetleg a sztringek kivételével - ne fordítsd le. Vigyázz, hogy kódra utaló sztringeket ne fordíts le!
34+
35+
Példa:
36+
```js
37+
// Example
38+
const element = <h1>Hello, world</h1>;
39+
ReactDOM.render(element, document.getElementById('root'));
40+
```
41+
42+
✅ TEDD:
43+
44+
```js
45+
// Példa
46+
const element = <h1>Hello, world</h1>;
47+
ReactDOM.render(element, document.getElementById('root'));
48+
```
49+
50+
✅ EZ IS OK:
51+
52+
```js
53+
// Példa
54+
const element = <h1>Helló világ</h1>;
55+
ReactDOM.render(element, document.getElementById('root'));
56+
```
57+
58+
❌ NE TEDD:
59+
60+
```js
61+
// Példa
62+
const element = <h1>Helló világ</h1>;
63+
// "root" refers to an element ID.
64+
// DO NOT TRANSLATE
65+
ReactDOM.render(element, document.getElementById('gyökér'));
66+
```
67+
68+
❌ SEMMIKÉPP NE TEDD:
69+
70+
```js
71+
// Példa
72+
const elem = <h1>Helló világ</h1>;
73+
ReactDOM.renderelés(elem, dokumentum.elemKiemeléseAzonosítóval('gyökér'));
74+
```
75+
76+
## Külső linkek
77+
78+
Ha egy külső link például egy az [MDN]-en vagy [Wikipédia]-n lévő cikkre mutat, és az adott cikk rendelkezik magyar fordítással, akkor azt a verziót linkeld.
79+
80+
[MDN]: https://developer.mozilla.org/hu/
81+
[Wikipédia]: https://hu.wikipedia.org/wiki/Kezd%C5%91lap
82+
83+
Példa:
84+
85+
```md
86+
React is a [JavaScript library](https://en.wikipedia.org/wiki/JavaScript_library).
87+
```
88+
89+
✅ OK:
90+
91+
```md
92+
A React egy [JavaScript keretrendszer](https://hu.wikipedia.org/wiki/JavaScript_keretrendszer).
93+
```
94+
95+
Egyéb esetben (pl.: Stack Overflow, YouTube videók, stb.), linkelj az angol forráshoz.
96+
97+
## A gyakori technikai, vagy React specifikus kifejezések szótárát itt találod:
98+
[ Glossary 📚 #2](https://github.com/reactjs/hu.reactjs.org/issues/2)
99+
100+
## Hasznos források:
101+
102+
1. [Angol-magyar informatikai szótár](https://www.tankonyvtar.hu/hu/tartalom/tkt/angol-magyar/index.html)
103+
2. [IT-Szótár](http://www.itszotar.hu/)
104+
(Tippeket elfogadunk 😉)
105+
106+
**Annak érdekében, hogy külsős - magyarul nem beszélő - karbantartók is követni tudják a fordítási folyamatot, a forráskódban és Giten/GitHubon (pl.: Git commit üzenetben, Git issue hozzászólásokban) használd az angolt, amennyiben az nem akadályoz meg a tiszta, egyértelmű kommunikációban.**
107+
108+
### Egyéb
109+
- Az olvasót egyes szám második személyként (tegeződő) formában szólítsd meg. (Nincs szükség formalitásra. 🚫🧐)
110+
- Ahol lehet, ragaszkodj az eredeti kis-nagy betűíráshoz.
111+
- Figyelj az egyes- és többeszámokra.
112+
- Ha kérdésed van, nyiss egy issue-t GitHubon, vagy írj @balazsorban44-nek, vagy @FeherMarcell-nek.

0 commit comments

Comments
 (0)