Contribute, and help us improve
Nabór tłumaczy! Szukamy tłumaczy do pomocy w udostępnieniu tej specyfikacji dla każdego!
Pracujemy na Slacku, dołącz jeśli tylko masz ochotę!
Pomóż usprawniać dokumentacje all-contributors!
Dziękujemy za zainteresowanie projektem! Pull Requesty dowolnej wielkości są mile widziane, od małej literówki po nową sekcję, pomóżcie nam ulepszyć ten projekt.
Cały Kod źródłowy jest dostępny na github.com/all-contributors/all-contributors
Wdrążanie nowych autorów
Oferujemy wdrążanie nowych współtwórców, jeśli jesteś zainteresowany by wziąć udział, napisz komentarz na Slacku.
Wprowadzanie zmian w repozytorium all-contributors
Używamy konwencji commitów angular dla comitów. Jest ona używana w celu automatyzacji generowania historii zmian, więc byłoby wskazane, aby z niej korzystać. Jeżeli nie jesteś do niej przyzwyczajony lub boisz się zrobić błąd użyj npm run commit
lub git cz
(jeżeli masz zainstalowany commitizen
), poprowadzi cię to przez kilka pytań i napisze commit za ciebie.
Edycja Treści
Podpowiedź: Każda strona ma przycisk Edycji na górze, kliknięcie go zabierze Cię bezpośrednio do kodu źródłowego danej strony
W pliku kliknij ikonę "ołówka" by łatwo edytować plik
Tłumaczenia
Nasze tłumaczenia są tworzone poprzez crowdin. Możesz pomóc we współtworzeniu kierując się do the crowdin project i sugerować tłumaczenia. Jeśli chcesz dodaj komentarz tutaj, aby poinformować nas, że pomagasz lub jeśli masz jakieś pytania!
When translating, it's important that anything that has the XPATH
@href
,@src
etc should not be translated. Rzeczy takie jakcode
również nie powinny być. Spowoduje to przekierowanie projektu do 404. Zobacz poniższy obrazek dla przykładu:Jednakże, zaleca się tłumaczenie wszystkich części, które mogą przyczynić się do lepszego zrozumienia, takich jak komentarze w
code
tagi dopóki nie zmienią one rzeczywistego kodu, który rozumie tylko język angielski.
Jak to zrobić
Logowanie do Crowdin
- Przejdź na stronę crowdin projektu, a następnie zarejestruj się i/lub zaloguj.
- Dołącz do projektu "All Contributors" i gotowe!
Tłumaczenie tekstu
- Przejdź do projektu na Crowdin.
- Kliknij flagę języka, którego dokumentację chciałbyś tłumaczyć.
- Kliknij którykolwiek z
*.md
plików, które nie są w pełni przetłumaczone (czyli takich, które nie mają obok siebie napisu: 100%). - Napisz swoje tłumaczenie w polu "Enter translation here" (co odpowiada tłumaczeniu w polu "SOURCE STRING" powyżej) następnie kliknij "SAVE"
- Tylko dla korektorów: możesz albo zatwierdzić sugestię tłumaczenia (bez znaczenia czy swoją czy czyjąś), którą znajdziesz w sekcji "[LANGUAGE] TŁUMACZENIA" poprzez kliknięcie w :ballot_box_with_check: lub usunąć je za pomocą ikony :wastebasket: .
Zmiana wdrożeń
Po przetłumaczeniu tekstu w danym języku, nie zobaczysz tych zmian dopóty, dopóki gałąź master
nie zostanie zaktualizowana, a następnie pomyślnie wdrożona.
Wyszukiwanie
Wyszukiwanie odbywa się wg algolii, konfiguracja znajduje się na https://github.com/algolia/docsearch-configs/blob/master/configs/all-contributors.json
Uruchamianie witryny lokalnie:
Wszyscy współtwórcy wykorzystują Docusaurus do utrzymywania naszej strony dokumentacji. Aby uzyskać więcej informacji odwiedź stronę Docusaurus
Aby rozpocząć lokalnie:
yarn install
yarn start
- przejdź do
http://localhost:3000
(odśwież stronę, aby zmiany były widoczne)
Dodaj siebie jako kontrybutor
Aby dodać się do tabeli kontrybutorów, postępuj zgodnie z instrukcją użytkowania bota ;).