netalertx-code-standards
NetAlertX coding standards and conventions. Use this when writing code, reviewing code, or implementing features.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
NetAlertX coding standards and conventions. Use this when writing code, reviewing code, or implementing features.
How to use
Zainstaluj umiejętność w swoim środowisku NetAlertX, wskazując ścieżkę do repozytorium
.github/skills/code-standards.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ń.
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()zplugin_helper.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.
Do pobierania bieżącego czasu używaj wyłącznie funkcji
timeNowUTC()zutils.datetime_utils– wszystkie znaczniki czasu w bazie danych muszą być przechowywane w UTC.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.