Change Details

Opis tego, jak wygląda proces recenzji kodu. Na co zwracać uwagę i jak sugerować zmiany? # Proces ## 1. Sprawdzenie metadanych ### Tytuł rewizji Jaki jest tytuł rewizji? Tytuł powinien być zwięzły, ale zawierać kluczowe informacje, w kolejności: 1. co się zmieniło w projekcie, 2. jakiego projektu dotyczy dana rewizja. Kolejność jest istotna, ponieważ tytuł rewizji staje się tytułem commita w repozytorium. Jeżeli najpierw w tytule commita byłaby nazwa projektu, to lista commitów wyglądałaby mało użytecznie: ``` * sealpage - lorem ipsum * sealpage - set dolomet * sealpage - foo bar ``` Lepiej jest: ``` * Lorem ipsum w sealpage * Set dolomet w sealpage * Foo bar w sealpage ``` Informacja `w sealpage` jest nadmiarowa w tytułach commitów, ale jest przydatna w tytułach rewizji, ponieważ łatwiej wtedy na liście rewizji określić, która rewizja dotyczy którego projektu gdy jest ich bardzo dużo, co nierzadko się zdarza. Dlatego informacja o nazwie projektu nie musi znaleźć się w tytule commita przy lądowaniu rewizji - można ją ręcznie usunąć przed lądowaniem. Tytuły rewizji mogą być pisane albo po polsku, albo po angielsku - zależnie od tego, jaki język jest używany do pisania tytułów commitów w danym repozytorium. Jeżeli tytuł diffa nie pasuje do tytułów commitów w repozytorium, to trzeba do zrequestować zmianę tytułu diffa (lub zrobić to samodzielnie). Jeżeli w repozytorium powiązanym z rewizją nie widać ustalonego języka tytułów diffów, to trzeba to zgłosić na forum, ustalić jedną opcję i umieścić informację o wybranej opcji w README.md danego repozytorium. Przykłady dobrych tytułów rewizji: * "Komponent członków zespołu na stronie sealcode" * "Galeria zdjęć w sealpage" Przykłady złych tytułów rewizji: * "Sealpage - galeria zdjęć" (zła kolejność informacji) * "checkpoint" * "Kopmoment członków zespołu na stronie sealcode" (literówka) ## 2. Sprawdzenie treści taska

Opis tego, jak wygląda proces recenzji kodu. Na co zwracać uwagę i jak sugerować zmiany? # Proces Sprawdź kolejno następujące poniżej rzeczy. Postaraj się znaleźć jak najwięcej komentarzy i następnie zrób odpowiednio "Request changes" jeżeli rewizja wymaga zmian lub "accept", jeżeli wszystko jest OK ## 1. Sprawdzenie metadanych ### Tytuł rewizji Jaki jest tytuł rewizji? Tytuł powinien być zwięzły, ale zawierać kluczowe informacje, w kolejności: 1. co się zmieniło w projekcie, 2. jakiego projektu dotyczy dana rewizja. Kolejność jest istotna, ponieważ tytuł rewizji staje się tytułem commita w repozytorium. Jeżeli najpierw w tytule commita byłaby nazwa projektu, to lista commitów wyglądałaby mało użytecznie: ``` * sealpage - lorem ipsum * sealpage - set dolomet * sealpage - foo bar ``` Lepiej jest: ``` * Lorem ipsum w sealpage * Set dolomet w sealpage * Foo bar w sealpage ``` Informacja `w sealpage` jest nadmiarowa w tytułach commitów, ale jest przydatna w tytułach rewizji, ponieważ łatwiej wtedy na liście rewizji określić, która rewizja dotyczy którego projektu gdy jest ich bardzo dużo, co nierzadko się zdarza. Dlatego informacja o nazwie projektu nie musi znaleźć się w tytule commita przy lądowaniu rewizji - można ją ręcznie usunąć przed lądowaniem. Tytuły rewizji mogą być pisane albo po polsku, albo po angielsku - zależnie od tego, jaki język jest używany do pisania tytułów commitów w danym repozytorium. Jeżeli tytuł diffa nie pasuje do tytułów commitów w repozytorium, to trzeba do zrequestować zmianę tytułu diffa (lub zrobić to samodzielnie). Jeżeli w repozytorium powiązanym z rewizją nie widać ustalonego języka tytułów diffów, to trzeba to zgłosić na forum, ustalić jedną opcję i umieścić informację o wybranej opcji w README.md danego repozytorium. Należy także sprawdzić, czy tytuł rewizji nie zawiera błędów ortograficznych lub literówek. Przykłady dobrych tytułów rewizji: * "Komponent członków zespołu na stronie sealcode" * "Galeria zdjęć w sealpage" Przykłady złych tytułów rewizji: * "Sealpage - galeria zdjęć" (zła kolejność informacji) * "checkpoint" * "Kopmoment członków zespołu na stronie sealcode" (literówka) ### Podpięte taski ## 2. Sprawdzenie treści taska

Opis tego, jak wygląda proces recenzji kodu. Na co zwracać uwagę i jak sugerować zmiany? # Proces Sprawdź kolejno następujące poniżej rzeczy. Postaraj się znaleźć jak najwięcej komentarzy i następnie zrób odpowiednio "Request changes" jeżeli rewizja wymaga zmian lub "accept", jeżeli wszystko jest OK ## 1. Sprawdzenie metadanych ### Tytuł rewizji Jaki jest tytuł rewizji? Tytuł powinien być zwięzły, ale zawierać kluczowe informacje, w kolejności: 1. co się zmieniło w projekcie, 2. jakiego projektu dotyczy dana rewizja. Kolejność jest istotna, ponieważ tytuł rewizji staje się tytułem commita w repozytorium. Jeżeli najpierw w tytule commita byłaby nazwa projektu, to lista commitów wyglądałaby mało użytecznie: ``` * sealpage - lorem ipsum * sealpage - set dolomet * sealpage - foo bar ``` Lepiej jest: ``` * Lorem ipsum w sealpage * Set dolomet w sealpage * Foo bar w sealpage ``` Informacja `w sealpage` jest nadmiarowa w tytułach commitów, ale jest przydatna w tytułach rewizji, ponieważ łatwiej wtedy na liście rewizji określić, która rewizja dotyczy którego projektu gdy jest ich bardzo dużo, co nierzadko się zdarza. Dlatego informacja o nazwie projektu nie musi znaleźć się w tytule commita przy lądowaniu rewizji - można ją ręcznie usunąć przed lądowaniem. Tytuły rewizji mogą być pisane albo po polsku, albo po angielsku - zależnie od tego, jaki język jest używany do pisania tytułów commitów w danym repozytorium. Jeżeli tytuł diffa nie pasuje do tytułów commitów w repozytorium, to trzeba do zrequestować zmianę tytułu diffa (lub zrobić to samodzielnie). Jeżeli w repozytorium powiązanym z rewizją nie widać ustalonego języka tytułów diffów, to trzeba to zgłosić na forum, ustalić jedną opcję i umieścić informację o wybranej opcji w README.md danego repozytorium. Należy także sprawdzić, czy tytuł rewizji nie zawiera błędów ortograficznych lub literówek. Przykłady dobrych tytułów rewizji: * "Komponent członków zespołu na stronie sealcode" * "Galeria zdjęć w sealpage" Przykłady złych tytułów rewizji: * "Sealpage - galeria zdjęć" (zła kolejność informacji) * "checkpoint" * "Kopmoment członków zespołu na stronie sealcode" (literówka) ### Podpięte taski ## 2. Sprawdzenie treści taska