summaryrefslogtreecommitdiff
path: root/site/contrib.pl.md
blob: 8d943404e40d556f87b2d5c40cee3c903b845a70 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
---
title: Informacje na temat wysyłania łatek do przejrzenia
x-toc-enable: true
...

Pobierz TransChat z repozytorium Git w ten sposób:

    git clone https://notabug.org/transchat/trans.chat.git

Git jest systemem kontroli wersji, używanym przy hostingu tej strony,
aby skoordynować jej rozwój. Możesz pobrać i pracować nad całą tą stroną
używając Gita.

Oprogramowanie Git dostępne jest na systemy Windows, MacOS, GNU+Linux, BSD i inne.
Zdecydowanie polecamy system GNU+Linux lub BSD, jednak Windows i MacOS również
dobrze działa z Gitem. Podstawowe informacje dotyczące korzystania z Gita
znajdziesz za pomocą wyszukiwarki internetowej.

Niektóre z tych instrukcji zakładają, że korzystasz z GNU+Linux lub BSD, więc
musisz dostosowywać je do siebie, jeśli używasz czegoś innego. Systemem operacyjnym
wykorzystywanym przez czołowych administratorów tej strony jest GNU+Linux.

Możesz zgłaszać swoje łatki za pośrednictwem
[pull requests na Notabug](#jak-zgłaszać-łatki-przez-pull-requests) lub poprzez

Edytowanie strony i dokumentacji w stylu wiki
---------------------------------------------

Strona oraz dokumentacja zawarta jest w katalogu `www` [repozytorium Git](#jak-pobrać-transchat-poprzez-Git)
w formacie Markdown w stylu Pandoc. Strona ta konwertowana jest do
statycznego HTML poprzez Pandoc, za pomocą skryptów, również umieszczonych w tym katalogu:

- index.sh: generuje kanał informacyjny (w sekcji „Nowości”)
- publish.sh: konwertuje pliki .md do formatu HTML
- Makefile: odwołując się do index.sh i publish.sh, kompiluje całą stronę TransChat

Wykorzystaj dowolny edytor tekstu (np. Vim, Emacs, Nano, Gedit) do edycji plików,
zatwierdź zmiany i [wyślij łatkę](#jak-zgłaszać-łatki-przez-pull-requests)

Opcjonalnie, możesz też zainstalować serwer WWW (np. lighttpd lub nginx)
lokalnie i ustawić katalog *www* z lokalnego repozytorium Git jako katalog główny.
Z taką konfiguracją, możesz generować lokalną wersję strony TransChat i przeglądać ją,
wpisując `localhost` w pasek adresu przeglądarki.

Prywatność współautorów (nie musisz ujawniać swojego imienia ani tożsamości!)
-----------------------------------------------------------------------------

Wkład, który wnosisz w naszą stronę jest publicznie rejestrowany w repozytorium
Git, do którego każdy ma dostęp. Obejmuje to nazwę użytkownika oraz adres
e-mail autora łatki.

Nie musisz używać nazwy użytkownika ani adresu e-mail odnoszącego
się do twojej tożsamości. Możesz wpisać cokolwiek, jeśli chcesz zachować
swoją prywatność.

Z prawnego punktu widzenia, wszystkie prawa autorskie automatycznie
obejmują postanowienia konwencji berneńskiej. Nieważne jest pod jaką nazwą
i czy w ogóle zadeklarujesz swoje prawa autorskie (wymagamy jednak publikowania
treści pod jedną z licencji wymienionych na tej stronie później)

Generalne wytyczne dotyczące zgłaszania łatek
---------------------------------------------

Wymagamy, aby wszystkie zgłaszane łatki dostępne były na wolnej licencji:
<https://www.gnu.org/licenses/license-list.pl.html>.

- 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.
- GNU General Public License v3 jest zalecane, jeśli dokonujesz zmian w kodzie (np. pracując nad skryptami używanymi do kompilacji tej strony)

Jeśli nie zgadzasz się na odpowiednie używanie jednej z tych licencji, twój wkład zostanie odrzucony.

*Zawsze* deklaruj licencję twojej pracy! Nie deklarując żadnej, sprawiasz, że
obowiązywać będą restrykcyjne prawa autorskie, które uczynią twoją
pracę niewolną.

GNU+Linux jest rekomendowany jako system operacyjny do pracy nad TransChat.

Generalne wytyczne przeglądu kodu
---------------------------------

Każda dowolna osoba może
[zgłosić swoją łatkę](#jak-zgłaszać-łatki-przez-pull-requests).

Zostanie ona przejrzana dla oceny jakości i zespojona z resztą strony po akceptacji.

Jak pobrać TransChat poprzez Git
------------------------------

Wprowadź w terminalu polecenie:

    git clone https://notabug.org/transchat/trans.chat.git

Utworzy to nowy katalog o nazwie `transchat`, zawierający pliki strony.
transchat.

Jak złaszać łatki (przez pull requests)
---------------------------------------

Załóż konto na <https://notabug.org/> i (będąc zalogowan\*) przejdź do strony
<https://notabug.org/transchat/trans.chat>. Naciśnik *Fork*, co utworzy
twoje własne repozytorium TransChat na twoim koncie użytkownika. Sklonuj swoje
repozytorium, zmień w nim co chcesz i wyślij to na swoje konto NotABug.

Teraz, przejdź do <https://notabug.org/trans.chat/pulls> i kliknij
*New Pull Request*.

Możesz w tym miejscu zgłaszać swoje poprawki. Alternatywnie, możesz też
zalogować się na kanał IRC TransChat i powiadomić o łatkach, które chcesz, aby
zostały przejrzane, jeśli posiadasz własne repozytorium, które je zawiera.

Gdy zgłosisz już pull request, opiekunowie witryny TransChat zostaną powiadomieni
o nim e-mailem. Jeśli nie dostaniesz szybkie odpowiedzi, możesz też
powiadomić członków projektu na kanale IRC `#transchat` w sieci Libera.