Skip to content

Latest commit

 

History

History
106 lines (89 loc) · 5.36 KB

CONTRIBUTING.md

File metadata and controls

106 lines (89 loc) · 5.36 KB

Współpraca

Spis treści

Zgłaszanie błędów

Przede wszystkim sprawdź, czy na gałęzi develop problem nie został już naprawiony lub czy problem nie został już zgłoszony

Jeśli nie, opisz, jaki to problem i gdzie go znajdziemy

Dodawanie nowego projketu

Jak zacząć?

  1. Stwórz fork'a repozytorium pod swoim kontem GitHub i sklonuj je na swoją maszynę
    git clone https://github.com/Pixel48/getLearn.git
    

    Note: Użyj konta, które będziesz mógł udostępnić przez Discord i odwrotnie - Serwery Discord są dość mocno powiązane z projektem

  2. Przejdź do ostatniej zmiany w gałęzi develop
    git checkout origin/develop
    
  3. Stwórz gałąź odpowiednią dla kategorii wprowadzanych zmian:
    • arkusz maturalny
    git checkout -b matura-<przedmiot>/<rok>/<miesiąc>
    
    • egzamin kwalifikacyjny
    git checkout -b q-<kod_kwalifikacji>
    
    • własny projekt
    git checkout -b programming<język_programowania>/<nazwa_projektu>
    

    Note: W nazwach gałęzi staraj się nie używać dużych liter, podkreśleń i spacji. Sporo osób używa gita w terminalu. Nie utrudniajmy im pracy

Co dalej?

Napisz lub dodaj pliki swojego projektu i zatwierdzaj kolejne zmiany w gałęzi swojego projektu. Pamiętaj o odpowiednim opisywaniu wprowadzanych zmian

Note: NIE ŁĄCZ swojej gałęzi z innymi - po przyjęciu pull request'a może być potrzebna normalizacja nazw plików, ścierzek i odnośników, aby zachować spójność z resztą repozytorium

Porządkowanie plików i wysyłanie zmian

Rozwiązanie arkusza

  1. Umieść rozwiązania do arkusza w folderze:
    matura/<przedmiot>/<rok>/<miesiąc>/rozwiązanie
  2. Umieść opracowywany arkusz w folderze:
    matura/<przedmiot>/<rok>/<miesiąc>/arkusz
  3. Na stronie fork'a utwórz pull request o nazwie matura-<przedmiot>/<rok>-<miesiąc>
    i krótkim opisem

Rozwiązanie egzaminu kwalifikacyjnego

  1. Umieść rozwiązania do arkusza w folderze:
    <XX>/<00>/<rok>/<miesiąc>/arkusz <numer arkusza>/rozwiązanie
  2. Umieść arkusz w folderze:
    <XX>/<00>/<rok>/<miesiąc>/arkusz <numer arkusza>/arkusz
  3. Na stronie fork'a utwórz pull request o nazwie <XX>-<00>/<rok>-<miesiąc>/arkusz <numer arkusza>
    i krótkim opisem

Projekt

  1. Umieść pliki projektu w folderze:
    <kategoria>/<podkategoria>/<nazwa_projektu>
  2. W głównym katalogu projektu napisz plik README.md opisujący twój projekt
  3. Na stronie fork'a utwórz pull request z adekwatną nazwą i krótkim opisem wprowadzonych zmian

Pull request & Direct access

Używając fork'ow i pull request'ów proponujesz wprowadzenie swoich zmian do repozytorium. Użytkownicy z dostępem bezpośrednim decydują o ich akceptacji i mogą dodawać zmiany bezpośrednio w repozytorium

Jak uzyskać bezpośredni dostęp?

Wprowadzaj zmiany

Dodawaj nowe projekty i ulepszaj istniejące. Osoby aktywnie rozwijające projekt na pewno szybko zostaną zauważone

Prowadź wykłady

Ucz innych tego, czego potrafisz nauczyć i zapowiadaj swoje lekcje. Serwery Discord są otwarte dla wszystkich, ale będą bezużyteczne, jeżeli będziemy tylko czekać na nauczyciela

Pomagaj innym

Odpowiadaj na pytania, doradzaj, wyjaśniaj. Jeżeli potrafisz pomóc - pomagaj. Szybko staniesz się rozpoznawalny na serwerach i uzyskasz odpowiednie rangi. Regularnie sprawdzamy, czy w społeczności nie pojawił się ktoś odpowiedni do nadzoru nad projektem

Bądź ogarnięty

Używaj prawdziwych nazw plików i nie trzymaj wszystkich kawałków projektu w podstawowym folderze. Nikt nie ma czasu ani ochoty szukać jednego rozwiązania w przydługiej liście losowych ciągów znaków

Nie bądź dzbanem

Traktuj innych z szacunkiem, nie używaj przekleństw jako interpunkcji. Bądź otwarty na dyskusje i czerp z krytyki. Nie musisz podnosić kultury dyskusji, ale na przynajmniej jej nie obniżaj

Archiwizuj

Jeżeli uczestniczysz w lekcji, nagraj ją (oczywiście za zgodą prowadzącego); Jeżeli nauczyciel nie wrzuci projektu do repozytorium, poproś go o pliki (i spytaj, czy ty możesz to zrobić). Nagranie będzie można wrzucić obok świerzego projektu. Dla kogoś to może być kwestia jego "Być albo nie być"

Licencja

Projekt objęty jest licencją GNU GPL 3