Instrukcja do obsługi Githuba #124
Conversation
|
Tutaj można podejrzeć jak to będzie wyglądało w głównym repozytorium: https://github.com/KSchlagowski/Ustawy-o-PIT/tree/ExtendReadmeByAddingInstrunctionsOnHowToUseGithub |
README.md
Outdated
|
|
||
| ## Jak używać Github i współtworzyć ustawę o PIT | ||
|
|
||
| [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. |
There was a problem hiding this comment.
W tym akapicie brakuje mi:
- Jasnego określenia jaki charakter ma ten projekt? Czy jest rzeczywiscie otwarto źródłowy i im szersza grupa zaangażowanych osób tym lepiej? Czy może jest to projekt ustawy stworzony i rozwijany przez zamkniętą grupę osób, a GitHub to jedynie sposób na publikację i promocję?
- W aktualnej formie jest to jedynie wskazówka techniczna. Brakuje słów zachęty do współtworzenia typu
Zawsze doceniamy wkład społeczności. (...).
There was a problem hiding this comment.
Jedynki sam nie opiszę, dwójka dodana.
…ttps://github.com/KSchlagowski/Ustawy-o-PIT into ExtendReadmeByAddingInstrunctionsOnHowToUseGithub
|
Zastanawia mnie na ile opisy zmian powinny być po angielsku. Chodzi mi o to, że jeśli sprawdzisz historię zmian to nawet @TomaszMentzen wrzuca w języku polskim. Aby była jakaś spójność to może warto to wpisać w zasady. Wiem, że jako programiści i całe community githuba jesteśmy raczej przyzwyczajeni do opisów zmian po angielsku, ale tu chyba to nie ma sensu. |
CONTRIBUTING.md
Outdated
|
|
||
| ## 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! 📝 |
There was a problem hiding this comment.
| 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! 📝 | |
| 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 GitHuba i szczegółów dotyczących tego jak pomóc w rozwoju nowej ustawy o podatku dochodowym! 📝 |
README.md
Outdated
| @@ -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 | |||
There was a problem hiding this comment.
| ## Jak używać Github i współtworzyć ustawę o PIT | |
| ## Jak używać GitHuba i współtworzyć ustawę o PIT |
Można odmieniać normalnie chyba
There was a problem hiding this comment.
Raczej można odmieniać, ale pozostałbym przy jednym schemacie - "platforma GitHub". Dzięki wielkie za pomoc! Dużo dobrych zmian zaproponowałeś.
Co-authored-by: Jakubk15 <[email protected]>
| @@ -81,7 +81,7 @@ Głowną różnicą między Issue, a Pull Request jest to, że do stworzenia Pul | |||
| * 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 skończyłeś edytować, 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 "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 miarę możliwości pisz commity po polsku. | |||
There was a problem hiding this comment.
W miarę możliwości pisz commity po polsku.
Przepraszam, ale to zdanie nie ma sensu co najmniej z dwóch powodów:
- w miarę możliwości jest mocno subiektywne
- commity po polsku.... no to po polsku czy nie? Jeśli chcemy po polsku to używajmy "zatwierdzenie" ; "zatwierdzenie zmian"
Ogólnie nie widzę sensu w dyskusjach "Słuchajcie piszmy po polsku" "Lepiej po angielsku" .... dajmy sobie z tym spokój i piszmy naturalnym językiem społeczności, którym w obecnych czasach jest mieszanka polskiego i angielskiego.
|
@MacDada jakiś komentarz? |
|
Zauważyłem, że instrukcja nie opisuje jak działają konflikty, warto byłoby wspomnieć o tej niesamowicie ważnej kwestii, szczególnie gdy PR'ki będą merge'owane w większej częstotliwości to te konflikty będą się często pojawiać. Można podlinkować w instrukcji dokumentację GitHuba |
Napisałem instrukcję korzystania z Githuba i współtworzenia ustawy o PIT na podstawie Issue zaproponowanego przez Janakanty i piotrminkina Fixes: #13.
Zapraszam do ulepszania instrukcji i wprowadzania zmian. Znam się w miarę na Git i programowaniu, ale nie na podatkach, więc to jedyne w czym mogę pomóc ;).