code-style-guide
Project coding standards and style guidelines. Always follow these conventions when writing or reviewing code.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Project coding standards and style guidelines. Always follow these conventions when writing or reviewing code.
How to use
Zainstaluj skill code-style-guide w swoim projekcie, dodając go do konfiguracji OpenHands lub integrując z narzędziem do analizy kodu.
Przeczytaj sekcję Python – zapamiętaj, że wcięcia muszą mieć dokładnie 4 spacje, a maksymalna długość linii to 88 znaków (standard Black). Używaj f-stringów zamiast .format() lub formatowania %.
Zastosuj konwencje nazewnictwa: klasy w PascalCase (np. MyClass), funkcje i zmienne w snake_case (np. my_function), stałe w UPPER_SNAKE_CASE (np. MAX_SIZE), a prywatne elementy z podkreśleniem na początku (_private_var).
Dodaj docstrings do wszystkich publicznych funkcji w stylu Google, zawierające opis, parametry i zwracaną wartość. Jeśli nie używasz type hints, umieść informacje o typach w docstringu.
Podczas przeglądu kodu sprawdź, czy nowy kod spełnia wszystkie wymienione konwencje – długość linii, nazewnictwo, dokumentację i type hints w sygnaturach funkcji.
Integruj skill z CI/CD lub narzędziem lintowania, aby automatycznie sprawdzać zgodność z wytycznymi przy każdym commicie.