3.2 KiB
| content_template | title | linktitle | main_menu | weight |
|---|---|---|---|---|
| templates/concept | Weź udział w tworzeniu dokumentacji Kubernetesa | Weź udział | true | 80 |
{{% capture overview %}}
Będzie nam bardzo miło, jeśli zechcesz wziąć udział w tworzeniu dokumentacji lub strony www Kubernetesa! Nieważne, czy dopiero poznajesz projekt, czy jesteś z nami już od dawna, czy uważasz się za programistę, użytkownika, czy po prostu nie możesz patrzeć na literówki.
{{% /capture %}}
{{% capture body %}}
Od czego zacząć?
Każdy może otworzyć zgłoszenie, które zawiera opis problemu czy oczekiwane usprawnienia dokumentacji lub samemu zaproponować zmianę poprzez pull request (PR). Do realizacji niektórych zadań potrzeba wyższego poziomu zaufania i odpowiednich uprawnień w organizacji Kubernetes. Zajrzyj do Participating in SIG Docs po więcej szczegółów dotyczących ról i uprawnień.
Dokumentacja Kubernetesa znajduje się w repozytorium GitHub. Zapraszamy wszystkich do aktywnych działań na rzecz jej rozwoju, niemniej aby móc sprawnie funkcjonować w społeczności Kubernetes, wymagana jest pewna biegłość w korzystaniu z git i GitHuba.
Aby zaangażować się w prace nad dokumentacją należy:
- Podpisać Contributor License Agreement CNCF.
- Zapoznać się z repozytorium dokumentacji i z generatorem statycznej strony www.
- Zrozumieć podstawowe procesy ulepszania zawartości i recenzowania propozycji zmian.
Najlepsze praktyki zgłaszania zmian
- Opis GIT commit powinien być jasny i zrozumiały.
- Należy używać Github Special Keywords, które odwołują się do zgłoszenia (issue) i automatycznie je zamykają, kiedy PR zostaje zaakceptowany.
- Kiedy wprowadzasz drobne zmiany do PR, takie jak literówki czy poprawki stylu lub gramatyki, pamiętaj o ich zgrupowaniu (squash), aby uniknąć sytuacji, kiedy mamy dużą liczbę commitów dla stosunkowo niewielkiej zmiany.
- Dołącz dobry opis PR, który tłumaczy zmiany w kodzie, powód dla tych zmian i wszystkie informacje wystarczające, aby recenzent zrozumiał Twój PR.
- Dodatkowa literatura:
Inne metody współpracy
- Aby włączyć się w prace społeczności Kubernetes poprzez fora internetowe, typu Twitter czy Stack Overflow, lub dowiedzieć się więcej na temat organizowanych lokalnie spotkań i wydarzeń związanym z projektem, zajrzyj na stronę społeczności Kubernetes.
- Aby włączyć się w prace związane z nowymi funkcjonalnościami, przeczytaj na początek ściągawkę dla współautorów.
{{% /capture %}}