Skip to content

Commit 23daff2

Browse files
committed
docs: add CONTRIBUTING.MD
Describe guidelines and conventions on how to work on polish translations
1 parent 79d47b9 commit 23daff2

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Porady pracy z polskim tłumaczeniem dokumentacji Vue.js
2+
3+
## Jak wnieść swój wkład?
4+
5+
### Aktualizowanie polskiej dokumentacji
6+
7+
W przypadku aktualizacji polskiej dokumentacji o zmiany pojawiające się na branchu `main` repozytorium głównego, w repozytorium polskiego tłumaczenia automatycznie będą pojawiać się adekwatne issues dzięki workflow narzędzia Ryu Cho.
8+
9+
1. Issues możemy znaleźć w następującym miejscu: https://github.com/monterail/vue3-docs-pl/issues
10+
2. Szukamy nieprzydzielonego do nikogo issue i deklarujemy chęć pracy, najlepiej komentarzem (np. "Hej, chciałbym zająć się tym issue :)"). Opiekunowie repozytorium mogą przydzielić się sami używając funkcji `assign yourself`, w innym wypadku po zobaczeniu Twojego komentarza, któryś z opiekunów przydzieli Tobie issue.
11+
3. Utwórz fork tego repozytorium, zapoznaj się z `README.md` oraz odpowiednimi poradnikami.
12+
4. Utwórz feature branch odbijając się od brancha `main` (np. `git branch my-branch main`).
13+
5. Utwórz commit z ze zmianami (np. `git commit -am 'docs: fix typo'`).
14+
6. Wypchnij zmiany do swojego forka (np. `git push origin my-branch`).
15+
7. Utwórz pull request aby dodać zmiany ze swojego brancha do brancha main tego repozytorium. Warto zawrzeć w nim tekst `resolve #123` (gdzie 123 to numer odpowiedniego issue) - w ten sposób pull request zostanie podlinkowany do issue.
16+
8. W przypadku uwag podczas code review - zaadresuj je i poproś o ponowne review. Upewnij się, że zaadresowano wszystkie komentarze/uwagi.
17+
9. Jeśli wszystko jest, otrzymasz zielone światło, a Twoje zmiany zostaną zmerge'owane do repozytorium :tada:
18+
19+
### Wskazywanie poprawek/literówek
20+
21+
1. Utwórz nowy issue w repozytorium opisujący problem.
22+
2. Jeśli to możliwe warto wskazać link i/lub plik źródłowy w którym występuje błąd.
23+
3. Jeśli chcesz również naprawić wskazany problem - dodaj stosowny komentarz i podąrzaj krokami powyżej. Opiekunowie repozytorium przydzielą Tobie utworzony przez Ciebie issue.
24+
25+
## Styl i sposób tłumaczeń
26+
27+
### Terminologia i słownictwo
28+
29+
* Nie tłumaczymy terminów "na siłę" na język polski - terminy takie jak `composables` są jak najbardziej OK do zostawienia w języku angielskim i będą brzmiały naturalnie
30+
31+
## Inne
32+
33+
### Nie dodawaj ani nie usuwaj linii
34+
35+
Utrzymanie jednolitej ilości linii i numerów wierszy ułatwia aktualizowanie polskiego tłumaczenia o zmiany zachodzące w oryginalnym tekście po angielsku.
36+
Prosimy więc nie dodawać nowych linii i nie usuwać pustych linii w plikach.
37+
38+
Oryginalny tekst:
39+
40+
```text
41+
Vue is a mature and battle-tested framework. It is one of the most widely used JavaScript frameworks ...
42+
43+
Vue is used in production by renowned organizations in varying capacities all around the world, including ...
44+
```
45+
46+
Źle, nowe zdanie w nowej linii ❌
47+
48+
```text
49+
Vue to dojrzały i sprawdzony w boju framework.
50+
Jest to jeden z najbardziej popularnych frameworków JavaScript ...
51+
52+
Vue jest używany produkcyjnie róznym stopniu na całym świecie przez wiele różnych organizacji, wliczając ...
53+
```
54+
55+
56+
Źle, usunięta pusta linia ❌
57+
58+
```text
59+
Vue to dojrzały i sprawdzony w boju framework. Jest to jeden z najbardziej popularnych frameworków JavaScript...
60+
Vue jest używany produkcyjnie róznym stopniu na całym świecie przez wiele różnych organizacji, wliczając ...
61+
```
62+
63+
64+
OK, linie pozostawione bez zmian ✔️
65+
66+
```text
67+
Vue to dojrzały i sprawdzony w boju framework. Jest to jeden z najbardziej popularnych frameworków JavaScript...
68+
69+
Vue jest używany produkcyjnie róznym stopniu na całym świecie przez wiele różnych organizacji, wliczając ...
70+
```

0 commit comments

Comments
 (0)