Twój wkład w ten projekt powinien być jak najprostszy i najbardziej przejrzysty, niezależnie od tego, czy chodzi o:
- Zgłoszenie błędu
- Omówienie aktualnego stanu kodu
- Przesłanie poprawki
- Proponowanie nowych funkcji
Github służy do hostowania kodu, śledzenia problemów i próśb o funkcje, a także do akceptowania pull requestów.
Pull requesty to najlepszy sposób na proponowanie zmian w bazie kodu.
- Wykonaj fork repozytorium i utwórz gałąź
master, - Jeśli coś zmieniłeś, koniecznie zaktualizuj dokumentację w jasny i spójny sposób, stosując najlepsze praktyki kodowania,
- Upewnij się, że Twój kod jest lintowany (używając czarnego koloru),
- Przetestuj swoje zmiany,
- Zgłoś pull request!
Krótko mówiąc, gdy przesyłasz zmiany w kodzie, uznaje się, że Twoje zgłoszenia podlegają tej samej licencji MIT, która obejmuje projekt. W razie wątpliwości skontaktuj się z deweloperami kodu.
Zgłaszaj błędy za pomocą problemów w GitHubie
Zgłoszenia w GitHubie służą do śledzenia publicznych błędów. Zgłoś błąd, otwierając nowe zgłoszenie. To takie proste..
Dobre zgłoszenia błędów zazwyczaj zawierają:
- Krótkie podsumowanie i/lub kontekst błędu
- Kroki do odtworzenia błędu
- Bądź konkretny!
- Podaj przykładowy kod, jeśli to możliwe.
- Czego się spodziewałeś
- Co się faktycznie dzieje
- Notatki (ewentualnie z wyjaśnieniem, dlaczego tak się dzieje lub co próbowałeś, ale nie zadziałało)
Ludzie uwielbiają dokładne raporty o błędach!
Użyj black, aby upewnić się, że kod jest zgodny ze stylem.
Ten niestandardowy komponent jest oparty na najlepszych praktykach, opisanych w szablonie blueprint integracji.
Dostarczany jest ze środowiskiem programistycznym w kontenerze, łatwym do uruchomienia, jeśli używasz Visual Studio Code. Dzięki temu kontenerowi będziesz mieć autonomiczną instancję Home Assistant działającą i skonfigurowaną za pomocą dołączonego pliku .devcontainer/configuration.yaml
.
Uczstnicząc w tym projekcie, wyrażasz zgodę na licencjonowanie swoich materiałów na podstawie licencji MIT.