Instrukcja do obsługi Githuba

CONTRIBUTING.md

@@ -0,0 +1,99 @@
+# Współtworzenie ustawy o PIT
+
+## Spis treści
+
+* [Wstęp](#wstęp)
+* [Przeglądanie plików](#przeglądanie-plików)
+* [Założenie konta na Github](#założenie-konta-na-Github)
+* [Poproś o wsparcie](#poproś-o-wsparcie)
+* [Zgłoś błąd lub poprawki](#zgłoś-błąd-lub-poprawki)
+* [Przeglądanie zmian innych](#przeglądanie-zmian-innych)
+* [Wnioskowanie o zmiany](#wnioskowanie-o-zmiany)
+
+## Wstęp
+
+Dziękujemy bardzo za zainteresowanie wkładem własnym do uproszczenia i obniżenia podatków!. Doceniamy wszelki rodzaj zaangażowania i zachęcamy do aktywności. Poniżej dowiesz się jak korzystać z platformy Github i szczegółów dotyczących tego jak pomóc w rozwoju nowej ustawy o podatku dochodowym! 📝
+
+Przed dokonaniem swojego wkładu, upewnij się, że przeczytałeś odpowiednią sekcję! Ułatwi to pracę nam, osobom odpowiedzialnym za utrzymanie projektu, oraz umili doświadczenie wszystkim zaangażowanym. 💚
+
+Czekamy na ciebie z niecierpliwością. 🙌🏾✨
+
+## Przeglądanie plików
+
+* Na głównej stronie projektu https://github.com/ProjektyUstaw/Ustawy-o-PIT u góry widnieją wszystkie pliki dodane w repozytorium. Po kliknięciu na jeden z nich (np. "Podstawowe założenia projektu.pdf") zobaczysz plik PDF z aktualną jego zawartością. W prawym górnym rogu widoku pliku znajduje się przycisk "Download raw file". Dzięki niemu możesz pobrać plik bezpośrednio na swój komputer, jeżeli chcesz go przeczytać używając innego programu. 
+* Na głównej stronie projektu znajduje się też folder "wersje tekstowe", gdzie prezentowana jest ta sama zawartość w innym rozszerzeniu pliku (.md zamiast .pdf). Jeżeli będziesz chciał pomóc w rozwoju projektu, to właśnie te pliki będziesz mógł edytować.
+
+## Założenie konta w serwisie Github
+
+Pierwsze co powinieneś zrobić, aby dodać swój wkład, to założyć konto na platformie Github. Jest to bardzo znane i lubiane narzędzie przez ludzi z branży IT. Odchodzimy od archaicznego podejścia do rozwoju polegającego na wrzuceniu pliku PDF do sieci i czekaniu na komentarze w emailach.
+Github pozwala na przetrzymywanie wielu wersji tego samego pliku, edycję plików przez wielu ludzi na raz oraz dyskusje na temat kierunku rozwoju projektu.
+
+* Załóż konto korzystając z linku: https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F&source=header-home
+
+## Poproś o wsparcie
+
+Jeśli masz pytanie dotyczące tego projektu lub potrzebujesz wyjaśnienia czegoś:
+
+* Otwórz dyskusję (discussion) na stronie https://github.com/ProjektyUstaw/Ustawy-o-PIT/discussions. Zrobisz to klikając w zielony guzik "New discussion" po prawej stronie.
+* Podaj jak najwięcej informacji na temat napotkanego problemu.
+
+Po zgłoszeniu:
+
+* Ktoś postara się jak najszybciej odpowiedzieć.
+* Jeżeli to ty komuś odpowiadasz, bądź uprzejmy w swoich wiadomościach.
+
+## Zgłoś błąd lub poprawki
+
+Jeśli napotkasz błąd w projekcie, lub chcesz zaproponować poprawki:
+
+* Wejdź w zakładkę problem (issue) na stronie https://github.com/ProjektyUstaw/Ustawy-o-PIT/issues i sprawdź czy ktoś już nie otworzył podobnego złoszenia.
+* Jeżeli podobne zgłoszenie już istnieje, możesz dodawać pod nim swoje komentarze oraz reagować na komentarze już istniejące.
+* Jeżeli podobne zgłoszenie nie istnieje, otwórz problem (issue) na stronie https://github.com/ProjektyUstaw/Ustawy-o-PIT/issues. Zrobisz to klikając w zielony guzik "New issue" po prawej stronie.
+* Podaj jak najwięcej informacji na temat napotkanego problemu lub poprawki. Proszę, staraj się być jasny dlaczego istniejące zapisy nie spełniają według ciebie twoich potrzeb.
+
+Po zgłoszeniu:
+
+* Ktoś postara się jak najszybciej odpowiedzieć.
+* Zespół projektowy może oznaczyć problem w zależności od tego, na ile uzna, że zgłoszenie jest istotne.
+* Jeśli Ty lub osoby odpowiedzialne za utrzymanie nie odpowiecie na problem przez 30 dni, problem zostanie zamknięty. Jeśli chcesz do niego wrócić, odpowiedz (proszę tylko raz), a my otworzymy istniejący problem ponownie. Prosimy unikać tworzenia nowych Issue jako rozszerzeń do już istniejących. Możesz dodawać komentarze do każdego Issue.
+
+## Przeglądanie zmian innych
+
+* Przejdź do https://github.com/ProjektyUstaw/Ustawy-o-PIT/pulls.
+* Znajdź i wejdź w zmianę, która cię interesuje.
+* Wejdź w zakładkę "Files changed", aby przejrzeć zaproponowane zmiany. Po lewej stronie znajduje się poprzednia wersja pliku, po prawej stronie znajdują się zmiany, które zaproponował dany użytkownik.
+* Możesz komentować propozycje naciskając na guzik niebieskiego plusa obok tekstu. 
+
+## Wnioskowanie o zmiany
+
+Jeżeli chcesz napisać i zaproponować konkretne zmiany możesz otworzyć tak zwany Pull Request.
+
+Bardzo lubimy wnioski o zmiany w projekcie! Są one niezwykle pomocne i pozwalają projektowi nadal działać i się rozwijać.
+
+Wnioski dotyczące zmian w ustawach o dowolnym rozmiarze są akceptowane!
+
+Głowną różnicą między Issue, a Pull Request jest to, że do stworzenia Pull Request wymagana jest podstawowa znajomość Git. Nie przejmuj się, nie jest to trudne. Jest na to kilka sposobów, ale zobaczmy najprostszy z nich.
+
+### Używając platformy Github
+
+* Na głównej stronie projektu https://github.com/ProjektyUstaw/Ustawy-o-PIT wejdź w folder "wersje tekstowe", a następnie plik, który chcesz edytować. W prawym górnym rogu widoku pliku, znajduję się guzik "Fork this repository and edit the file" w kształcie ołówka. Naciśnij go.
+* Wyskoczy komunikat "You need to fork this repository to propose changes.". Naciśnij "Fork this repository".
+* Jeżeli wyskoczy komunikat "Sorry, it looks like your fork is outdated!", naciśnij "Update your fork".
+* Wprowadź zmiany.
+* W prawym górnym rogu widoku pliku znajduje się zielony przycisk "Commit changes...". Jeżeli jesteś zadowolony ze swojej edycji, naciśnij go.
+* W oknie "Commit message" dajemy opis tak zwanego commita. Commity to zmiany, między którymi można przechodzić. Commitów w PR może być wiele. Napisz tam prostą, klarnowną wiadomość czego dotyczą twoje zmiany. Przykładowo może to być "Zaktualizuj Art. 2. rok podatkowy".
+* W oknie "Extended description" możesz dać bardziej szczegółowy opis zmian.
+* Naciśnij "Propose changes".
+* Naciśnij "Create pull request".
+* Wyskoczy okno opisu PR. Tytuł będzie się wyświetlał dla wszystkich użytkowników, postaraj się dobrze i zwięźle opisać wykonane zmiany. 
+* Możesz również dodać bardziej szczegółowy opis PR w większym oknie poniżej. Jeśli Twój PR jest powiązany z otwartym problemem (Issue), dodaj w opisie swojego PR linijkę zawierającą `Fixes: #123`, gdzie `#123` to numer Issue, którym się zajmujesz.
+* Pozostaw zaznaczone "Allow edits by maintainers".
+* Naciśnij "Create pull request".
+* Gratulacje, twoje propozycje zostały zaproponowane. Jeżeli chcesz się z nich wycofać, wystarczy, że naciśniesz przycisk "Close pull request" na dole widoku PR.
+
+Po złożeniu PR:
+
+* Jedna lub więcej osób odpowiedzialnych za projekt przejrzy twoją propozycję. Może ją zaakceptować, odrzucić, lub dodać komentarz.
+* Jeśli osoba odpowiedzialna za utrzymanie poprosi o jakieś zmiany, dokonaj tych zmian, wykonaj push i poproś o kolejną recenzję.
+* Jeśli osoba odpowiedzialna za utrzymanie zdecyduje, że nie zaakceptuje Twojego PR, podziękują Ci za kontrybucję i wyjaśnią, dlaczego nie przyjmują zmian. To w porządku! Bardzo doceniamy Twój wkład i nie lekceważymy go.
+* Jeśli Twój PR zostanie zaakceptowany, zostanie to oznaczone, a następnie scalone z odpowiednim plikiem. Twoja kontrybucja zostanie rozpowszechniona wśród użytkowników i zostanie oznaczona wersją np. v1.0, v1.1 itd.

README.md

@@ -2,3 +2,7 @@
 Dotychczas ustawa o podatku dochodowym od osób fizycznych w połączeniu z ustawą o zryczałtowanym podatku dochodowym liczyły ponad 500 stron. Była archaiczna, nieczytelna, przypominała śmietnik - każdy kolejny rząd, każdy kolejny premier i minister finansów wprowadzał tam swoje pomysły, jednak nikt nie był skory zająć się błędami poprzedników. Powstał bałagan, który posprzątać mogła tylko kompleksowa zmiana. Ustawy tworzą ze sobą sieć naczyń połączonych - każda wpływa na trzy kolejne. Celem prezentowanych trzech nowych ustaw było nie tylko obniżenie podatków, ale również ograniczenie tych połączeń, uproszczenie systematyki, a także racjonalizacja przepisów i pojęć. Współczesne przepisy są nieczytelne nie tylko dla zwykłych obywateli - często były niezrozumiałe również dla prawników. Pozwalały na szeroką dozę interpretacji, wymagały nieustannych zmian i komentarzy, a także wiążących objaśnień ze strony ministerstwa. Chaos był tak wielki i rozległy nie tylko przez objętość regulacji, ale także przez niestaranne, częste i nieprzemyślane zmiany w obrębie tego wielkiego bałaganu.
 
 Podstawowe założenie regulacji to niskie i proste podatki, automatyzacja rozliczeń, zachęcanie do inwestycji i przedsiębiorczości, a także wsparcie młodych i seniorów na rynku pracy.
+
+## Jak używać Github i współtworzyć ustawę o PIT
+
+Zawsze doceniamy wkład społeczności. [Kliknij tutaj](CONTRIBUTING.md), aby wyświetlić plik, który pomoże ci zrozumieć jak działa platforma Github oraz jak z niej korzystać, aby pomóc w rozwoju projektu.