Home

Cel projektu

"Rocznik" to system napisany w Ruby on Rails, wspierający pracę redakcji czasopisma "Rocznik Kognitywistyczny". Czasopismo dostępne jest obecnie na stronach http://ejournals.eu oraz http://kognitywistyka.eu. Proces wydawniczy czasopisma jest dość złożony, a wymagania Ministerstwa Nauki i Szkolnictwa Wyższego związane z parametryzacją jednostek naukowych jeszcze bardziej go komplikują. System ma pomóc w śledzeniu procesu recenzowania zgłoszonych artykułów oraz ułatwić sprawozdawanie informacji wymaganych przez ministerstwo.

Historie użytkowników

Historie użytkowników to opisy różnych funkcjonalności systemu z punktu widzenia konkretnych użytkowników oraz scenariuszy użycia. W przeciwieństwie do konkretnych zgłoszeń, pozwalają one lepiej uchwycić ogólny obraz systemu i zrozumieć cele jakie są osiągana przez użytkowników systemu.

• Monitorowanie procesu recenzji
• Wydawanie kolejnego numeru czasopisma
• Przeglądanie opublikowanych numerów
• Zgłaszanie artykułu do recenzji
• Sporządzanie recenzji
• Komunikacja z autorami i recenzentami
• Sprawozdawanie przed MNiSW
• Wybór recenzenta

Praca z kodem

1. Pracę z kodem rozpoczynamy od sklonowania repozytorium na własne konto na githubie. Robimy to klikając guzik "fork", który znajduje się po prawej stronie na górze tej strony.
2. Następnie pobieramy kod repozytorium na własny komputer:
   git clone <adres_repozytorium>
   np.
   git clone https://github.com/robson3999/rocznik.git
3. Przed rozpoczęciem pracy musimy upewnić się, czy mamy zainstalowaną bazę Postgres w wersji developerskiej. W Ubuntu instalujemy ją poleceniem
   sudo apt-get install postgresql-server-dev-9.3
4. Po pobraniu kodu przechodzimy do katalogu rocznik:
   cd rocznik
   i pobieramy zależności projektu:
   bundle
5. Następnie rozpoczynamy pracę nad kodem w nowym branchu (gałęzi kodu). Gałąź bierze nazwę od konkretnego numeru i nazwy zgłoszenia. Przykładowo jeśli pracujemy nad zgłoszeniem #87, to tworzymy następującą gałąź kodu:
   git checkout -b 87-dodanie-nazwiska
6. Po zakończeniu pracy nad kodem dodajemy zmiany do lokalnego repozytorium:
   git add .
git commit -m "Dodanie własnego nazwiska"
   
7. Następnie wysyłamy je na githuba. Ważne jest aby nazwa gałęzi na githubie była taka jak nazwa gałęzi lokalnej. Np. dla poprzedniego zgłoszenia polecenie to będzie wyglądało następująco:
   git push origin 87-dodanie-nazwiska
8. Następnie na stronie githuba wysyłamy tzw. pull-request. Robimy to na stronie głównej naszego projektu, klikając guzik "new pull request". W formularzu po lewej stronie powinna znaleźć się gałąź master z repozytorium github.com/apohllo/rocznik a po prawej nasza gałąź, w której dodaliśmy zmiany.
9. Jeśli okaże się, że konieczne jest wprowadzenie dodatkowych zmian, to robimy to powtarzając kroki 6 i 7. Zmiany te od razu pojawią się w naszym pull-requeście.
10. Czasami okaże się, że pull request nie może być automatyczne zmergowany (informuje o tym komunikat na stronie tworzenia pull requestu). Wtedy konieczne jest dostosowanie własnego kodu do zmian, które zaszły w głównej gałęzi projektu, czyli apohllo/master. Pobranie zmian wymaga najpierw dodania nowego zdalnego repozytorium apohllo (wykonujemy tylko raz dla swojego repozytorium):
    git remote add apohllo https://github.com/apohllo/rocznik.git
11. Następnie pobieramy zmiany z głównego repozytorium apohllo z gałęzi master': <br/> git pull apohllo master`
12. Następnie rozwiązujemy konflikt. Po jego usunięciu powtarzamy kroki 6 i 7.