Ustawy-o-PIT
Ustawy-o-PIT copied to clipboard
ProjektyUstaw
Wprowadzić mini instrukcję do obsługi githuba w .README
Dzisiaj dla mnie to już oczywiste, ale pamiętam swój pierwszy kontakt z Gitem. Wtedy zupełnie nie rozumiałem, jak go używać. Dlatego uważam, że warto dodać instrukcję lub informacje kontaktowe w pliku README dla osób, które nie mają wystarczającej wiedzy i doświadczenia z tym narzędziem. Właśnie dla takich osób Git powinien być jak najbardziej przystępny.
Moja propozycja polega na wprowadzeniu minimum wymagań, takich jak konieczność założenia konta, a następnie skierowanie użytkowników do sekcji "Issues" i "Discussions" za pomocą na przykład gifów. To może wydawać się banalne, ale mój tata, który posiada pewne doświadczenie w innej dziedzinie, nie byłby w stanie odnaleźć się tutaj bez takiej pomocy.
Moim skromnym zdaniem, póki temat jest świeży i parę osób (które się znają na podatkach) z ciekawości sprawdzi git'a, musi być dla nich dobrze wytłumaczony.
W README.md widziałbym raczej linka do pliku CONTRIBUTING.md, a właśnie w tym pliku zawrzeć instrukcje, o których wspominasz @Janakanty :)
Forma również dobra. @TomaszMentzen @BartoszPrzybysz @ProjektyUstawPodatkowych jak na to patrzycie?
Niechaj zainteresowani również wypowiedzą się w temacie, na jakie przeszkody natrafiają, chcąc dodać swoją cegiełkę do tych projektów. Może nawet poświęciłbym swój czas, w przygotowaniu takiej instrukcji.
Przy tym warto byłoby również gdzieś zaznaczyć w jaki sposób powinny być tworzone pull requesty, bo aktualnie w repozytorium na głównej stronie widać PDFy, a jak rozumiem one nie powinny być modyfikowane (zamiast tego wersje tekstowe). Opcjonalnie, przydałby się jakiś opis jak wygenerować te PDFy z wersji tekstowych, w celu podglądu.
Jesteśmy otwarci na wszelkie sugestie - postaramy się je wprowadzić w najbliższych dniach.
Tutaj już powstał PR do auto generowania PDFów: https://github.com/ProjektyUstaw/Ustawy-o-PIT/pull/33
Wydaje się, że powinniśmy modyfikować tylko pliki Markdown, natomiast PDFy powinny się generować same, właśnie jakimś automatem. Nie ma sensu przerzucać na userów, żeby każdy generował gdzieś na stronie trzeciej PDFy po swojemu i wrzucał je do repo. W readme powinien być link do pobrania najnowszych PDFów.
Jak ktoś nie umie korzystać z githuba to i pewnie nie rozumie co to readme.
Dla chcącego nic trudnego moi drodzy
Coś udało mi się wyrzeźbić. Jak możecie, to pomóżcie w ulepszeniu tego. https://github.com/ProjektyUstaw/Ustawy-o-PIT/pull/124
