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