diff options
Diffstat (limited to 'site/contrib.pl.md')
-rw-r--r-- | site/contrib.pl.md | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/site/contrib.pl.md b/site/contrib.pl.md new file mode 100644 index 0000000..8d94340 --- /dev/null +++ b/site/contrib.pl.md | |||
@@ -0,0 +1,113 @@ | |||
1 | --- | ||
2 | title: Informacje na temat wysyłania łatek do przejrzenia | ||
3 | x-toc-enable: true | ||
4 | ... | ||
5 | |||
6 | Pobierz TransChat z repozytorium Git w ten sposób: | ||
7 | |||
8 | git clone https://notabug.org/transchat/trans.chat.git | ||
9 | |||
10 | Git jest systemem kontroli wersji, używanym przy hostingu tej strony, | ||
11 | aby skoordynować jej rozwój. Możesz pobrać i pracować nad całą tą stroną | ||
12 | używając Gita. | ||
13 | |||
14 | Oprogramowanie Git dostępne jest na systemy Windows, MacOS, GNU+Linux, BSD i inne. | ||
15 | Zdecydowanie polecamy system GNU+Linux lub BSD, jednak Windows i MacOS również | ||
16 | dobrze działa z Gitem. Podstawowe informacje dotyczące korzystania z Gita | ||
17 | znajdziesz za pomocą wyszukiwarki internetowej. | ||
18 | |||
19 | Niektóre z tych instrukcji zakładają, że korzystasz z GNU+Linux lub BSD, więc | ||
20 | musisz dostosowywać je do siebie, jeśli używasz czegoś innego. Systemem operacyjnym | ||
21 | wykorzystywanym przez czołowych administratorów tej strony jest GNU+Linux. | ||
22 | |||
23 | Możesz zgłaszać swoje łatki za pośrednictwem | ||
24 | [pull requests na Notabug](#jak-zgłaszać-łatki-przez-pull-requests) lub poprzez | ||
25 | |||
26 | Edytowanie strony i dokumentacji w stylu wiki | ||
27 | --------------------------------------------- | ||
28 | |||
29 | Strona oraz dokumentacja zawarta jest w katalogu `www` [repozytorium Git](#jak-pobrać-transchat-poprzez-Git) | ||
30 | w formacie Markdown w stylu Pandoc. Strona ta konwertowana jest do | ||
31 | statycznego HTML poprzez Pandoc, za pomocą skryptów, również umieszczonych w tym katalogu: | ||
32 | |||
33 | - index.sh: generuje kanał informacyjny (w sekcji „Nowości”) | ||
34 | - publish.sh: konwertuje pliki .md do formatu HTML | ||
35 | - Makefile: odwołując się do index.sh i publish.sh, kompiluje całą stronę TransChat | ||
36 | |||
37 | Wykorzystaj dowolny edytor tekstu (np. Vim, Emacs, Nano, Gedit) do edycji plików, | ||
38 | zatwierdź zmiany i [wyślij łatkę](#jak-zgłaszać-łatki-przez-pull-requests) | ||
39 | |||
40 | Opcjonalnie, możesz też zainstalować serwer WWW (np. lighttpd lub nginx) | ||
41 | lokalnie i ustawić katalog *www* z lokalnego repozytorium Git jako katalog główny. | ||
42 | Z taką konfiguracją, możesz generować lokalną wersję strony TransChat i przeglądać ją, | ||
43 | wpisując `localhost` w pasek adresu przeglądarki. | ||
44 | |||
45 | Prywatność współautorów (nie musisz ujawniać swojego imienia ani tożsamości!) | ||
46 | ----------------------------------------------------------------------------- | ||
47 | |||
48 | Wkład, który wnosisz w naszą stronę jest publicznie rejestrowany w repozytorium | ||
49 | Git, do którego każdy ma dostęp. Obejmuje to nazwę użytkownika oraz adres | ||
50 | e-mail autora łatki. | ||
51 | |||
52 | Nie musisz używać nazwy użytkownika ani adresu e-mail odnoszącego | ||
53 | się do twojej tożsamości. Możesz wpisać cokolwiek, jeśli chcesz zachować | ||
54 | swoją prywatność. | ||
55 | |||
56 | Z prawnego punktu widzenia, wszystkie prawa autorskie automatycznie | ||
57 | obejmują postanowienia konwencji berneńskiej. Nieważne jest pod jaką nazwą | ||
58 | i czy w ogóle zadeklarujesz swoje prawa autorskie (wymagamy jednak publikowania | ||
59 | treści pod jedną z licencji wymienionych na tej stronie później) | ||
60 | |||
61 | Generalne wytyczne dotyczące zgłaszania łatek | ||
62 | --------------------------------------------- | ||
63 | |||
64 | Wymagamy, aby wszystkie zgłaszane łatki dostępne były na wolnej licencji: | ||
65 | <https://www.gnu.org/licenses/license-list.pl.html>. | ||
66 | |||
67 | - Dla dokumentacji wymagamy licencji GNU Free Documentation License w wersji 1.3 lub wyższej. Obejmuje to wszystkie strony na których wnosisz wkład lub które zmieniasz. | ||
68 | - GNU General Public License v3 jest zalecane, jeśli dokonujesz zmian w kodzie (np. pracując nad skryptami używanymi do kompilacji tej strony) | ||
69 | |||
70 | Jeśli nie zgadzasz się na odpowiednie używanie jednej z tych licencji, twój wkład zostanie odrzucony. | ||
71 | |||
72 | *Zawsze* deklaruj licencję twojej pracy! Nie deklarując żadnej, sprawiasz, że | ||
73 | obowiązywać będą restrykcyjne prawa autorskie, które uczynią twoją | ||
74 | pracę niewolną. | ||
75 | |||
76 | GNU+Linux jest rekomendowany jako system operacyjny do pracy nad TransChat. | ||
77 | |||
78 | Generalne wytyczne przeglądu kodu | ||
79 | --------------------------------- | ||
80 | |||
81 | Każda dowolna osoba może | ||
82 | [zgłosić swoją łatkę](#jak-zgłaszać-łatki-przez-pull-requests). | ||
83 | |||
84 | Zostanie ona przejrzana dla oceny jakości i zespojona z resztą strony po akceptacji. | ||
85 | |||
86 | Jak pobrać TransChat poprzez Git | ||
87 | ------------------------------ | ||
88 | |||
89 | Wprowadź w terminalu polecenie: | ||
90 | |||
91 | git clone https://notabug.org/transchat/trans.chat.git | ||
92 | |||
93 | Utworzy to nowy katalog o nazwie `transchat`, zawierający pliki strony. | ||
94 | transchat. | ||
95 | |||
96 | Jak złaszać łatki (przez pull requests) | ||
97 | --------------------------------------- | ||
98 | |||
99 | Załóż konto na <https://notabug.org/> i (będąc zalogowan\*) przejdź do strony | ||
100 | <https://notabug.org/transchat/trans.chat>. Naciśnik *Fork*, co utworzy | ||
101 | twoje własne repozytorium TransChat na twoim koncie użytkownika. Sklonuj swoje | ||
102 | repozytorium, zmień w nim co chcesz i wyślij to na swoje konto NotABug. | ||
103 | |||
104 | Teraz, przejdź do <https://notabug.org/trans.chat/pulls> i kliknij | ||
105 | *New Pull Request*. | ||
106 | |||
107 | Możesz w tym miejscu zgłaszać swoje poprawki. Alternatywnie, możesz też | ||
108 | zalogować się na kanał IRC TransChat i powiadomić o łatkach, które chcesz, aby | ||
109 | zostały przejrzane, jeśli posiadasz własne repozytorium, które je zawiera. | ||
110 | |||
111 | Gdy zgłosisz już pull request, opiekunowie witryny TransChat zostaną powiadomieni | ||
112 | o nim e-mailem. Jeśli nie dostaniesz szybkie odpowiedzi, możesz też | ||
113 | powiadomić członków projektu na kanale IRC `#transchat` w sieci Libera. | ||