Symfony Oficjalna Polska Dokumentacja Symfony 2.x

Przyczynianie się do rozwoju Dokumentacji

Przyczynianie się do rozwoju Dokumentacji

Dokumentacja jest tak samo ważna jak kod. Wywodzą się z tych samych zasad: DRY, testy, łatwość utrzymania, rozszerzalność, optymalizacja i refaktoryzacja, to tylko kilka z nich. Oczywiście, dokumentacja posiada błędy, literówki, ciężkie do przeczytania tutoriale, i tak dalej.

Wkład

Zanim zaczniesz tworzyć dokumentację, zapoznaj się z stosowanym w dokumentacji językiem znaczników.

Dokumentacja Symfony2 jest hostowana na GitHub:

https://github.com/symfony/symfony-docs

Jeśli chcesz wysłać poprawkę, wykonaj fork na oficjalnym repozytorium na GitHub oraz sklonuj swojego forka:

$ git clone git://github.com/YOURUSERNAME/symfony-docs.git

Następnie, stwórz dedykowanego brancha dla swoich zmian:

$ git checkout -b improving_foo_and_bar

Możesz tworzyć swoje zmiany bezpośrednio w tym branchu oraz je commitować. Gdy skończysz, możesz wykonać push brancha na twój fork na GitHub oraz wykonać pull request. Pull request zostanie wykonany pomiędzy Twoim branchem improving_foo_and_bar oraz branchem master z repozytorium symfony-docs.

../../_images/docs-pull-request.png

GitHub opisuje temat pull requests w szczegółach.

Uwaga

Dokumentacja Symfony2 jest na licencji Creative Commons Attribution-Share Alike 3.0 Unported License.

Raportowanie Błędu

Najprostszym wkładem w rozwój jest zgłaszanie błędów: literówki, błędu gramatycznego, błędu w przykładowym kodzie, brakującego wyjaśnienia, i tak dalej.

Kroki:

  • Wyślij błąd do bug trackera;
  • (opcjonalnie) Wyślij poprawkę.

Tłumaczenie

Przeczytaj dedykowany dokument.

Fork me on GitHub