netalertx-code-standards

Zestaw wytycznych kodowania i konwencji dla projektu NetAlertX. Używaj tej umiejętności podczas pisania kodu, przeglądu zmian lub implementacji nowych funkcji. Obejmuje zasady dotyczące długości plików, zasadę DRY, dostępu do bazy danych, obsługi adresów MAC, bezpieczeństwa procesów podrzędnych i standardów czasu UTC. Pomaga utrzymać kod łatwy w utrzymaniu, bez duplikacji i zgodny z architekturą projektu.

1. Zainstaluj umiejętność w swoim środowisku NetAlertX, wskazując ścieżkę do repozytorium .github/skills/code-standards.

2. Przed rozpoczęciem implementacji nowej funkcji lub przeglądu kodu, poproś asystenta AI o przygotowanie planu implementacji. Przejrzyj plan i zadaj pytania wyjaśniające dotyczące wymagań.

3. Podczas pisania kodu pamiętaj o kluczowych regułach: pliki nie powinny przekraczać 500 linii, stosuj zasadę DRY (nie powielaj kodu), dostęp do bazy danych realizuj wyłącznie poprzez funkcje z server/db/db_helper.py, a adresy MAC normalizuj za pomocą normalize_mac() z plugin_helper.

4. Wszystkie wywołania procesów podrzędnych muszą mieć jawnie ustawiony timeout minimum 60 sekund. Jeśli używasz zagnieżdżonych procesów, każdy z nich wymaga własnego timeoutu.

5. Do pobierania bieżącego czasu używaj wyłącznie funkcji timeNowUTC() z utils.datetime_utils – wszystkie znaczniki czasu w bazie danych muszą być przechowywane w UTC.

6. Po ukończeniu implementacji dodaj testy zgodnie z architekturą repozytorium, umieszczając je w odpowiednich katalogach (nie w głównym /test). Poproś o przegląd każdego etapu przed przejściem do następnego.