Jakość i Struktura Kodu
W Husaria Solutions szczycimy się utrzymaniem wysokich standardów jakości kodu. Czysty, czytelny i bezbłędny kod to nie tylko preferencja; to fundamentalna zasada kierująca naszymi praktykami programistycznymi. Kiedy współpracujesz przy naszych projektach open source, zachęcamy wszystkich programistów do przestrzegania poniższych wytycznych:
Czytelność i klarowność:
- Pisz kod, który łatwo się czyta i rozumie. Używaj znaczących nazw zmiennych i funkcji.
- Dołączaj komentarze, gdy jest to konieczne, aby wyjaśnić skomplikowaną logikę lub ważne decyzje.
Spójność:
- Zachowaj spójność konwencji kodowania w całym projekcie.
- Używaj spójnego stylu wcięć i przestrzegaj standardów kodowania TypeScript.
Obsługa błędów:
- Wprowadź solidną obsługę błędów, aby sprawnie zarządzać nieoczekiwanymi sytuacjami.
- Dostarcz czytelne komunikaty o błędach i informacje do logowania w celach debugowania.
TypeScript
Nasze projekty wykorzystują TypeScript, aby przynieść korzyści statycznego typowania do JavaScript. TypeScript poprawia jakość kodu, wykrywając potencjalne błędy podczas developmentu, poprawiając utrzymanie kodu i zapewniając lepsze wsparcie narzędziowe. Przy współpracy pamiętaj o następujących praktykach TypeScript:
Anotacje typów:
- Jasno definiuj typy zmiennych, parametrów i wartości zwracanych.
- Wykorzystuj system typów TypeScript, aby wyłapywać błędy związane z typami we wczesnej fazie procesu deweloperskiego.
Interfejsy i Typy:
- Stosuj interfejsy i typy do klarownego określania umów między różnymi częściami kodu.
- Zachęcaj do ponownego użycia i utrzymania kodu, korzystając z potężnego systemu typów TypeScript.
Enumeracje i Typy Unijne:
- Odpowiednio używaj enumeracji i typów unijnych do reprezentowania struktur danych z ograniczonym zestawem możliwości.
- Popraw ekspresywność kodu, wybierając odpowiednie konstrukcje TypeScript do swoich scenariuszy.
Zasady Projektowania Atomowego:
Oprócz utrzymania czystego i bezpiecznego kodu, nasze projekty przestrzegają zasad projektowania atomowego. Projektowanie atomowe to metodologia, która rozkłada interfejsy użytkownika na mniejsze, wielokrotnego użytku komponenty. Kiedy współpracujesz przy naszych projektach, rozważ poniższe zasady projektowania atomowego:
Atomy, Molekuły, Organizmy:
- Strukturyzuj swój kod w taki sposób, aby odzwierciedlał zasady projektowania atomowego.
- Projektuj małe, niezależne komponenty (atomy), które można łączyć, tworząc bardziej złożone komponenty (molekuły i organizmy).
Ponowne wykorzystanie:
- Zachęcaj do modularności i ponownego użycia kodu, tworząc komponenty, które można łatwo podłączyć do różnych części aplikacji.
- Wykorzystuj interfejsy TypeScript do jasnego określania granic i oczekiwań dotyczących użycia komponentów.
Spójność nazewnictwa komponentów:
- Stosuj konsekwentne konwencje nazewnicze dla swoich komponentów, aby ułatwić programistom ich identyfikację i użycie.
- Używaj przestrzeni nazw i katalogów do organizacji komponentów na podstawie ich kategorii w projektowaniu atomowym.