Zmiany w kodzie i aktualizacje Open Mercato
Zmiana może wpłynąć na trasy, zdarzenia, uprawnienia, zapisane dane i pliki generowane. Sprawdź te zależności przed aktualizacją frameworka lub udostępnieniem modułu innym zespołom.
Na tej stronie
Zachowaj nazwy używane przez inne części systemu
Trasa, nazwa zdarzenia, identyfikator uprawnienia lub klucz usługi może być używany poza zmienianym plikiem. Wyszukaj te miejsca przed zmianą nazwy. Sprawdź zasady zgodności projektu i opisz migrację, jeżeli zmieniasz interfejs.
Sposób wywołania
Przykładowa nazwa komendy. Zmiana danych wejściowych lub zachowania może wymagać migracji mimo zachowania nazwy.
Kod i dokumentacja
Lista do sprawdzenia przy zmianie
- Zmień plik źródłowy i odtwórz generowane rejestry.
- Sprawdź działanie dotychczasowych wywołań oraz nowej funkcji.
- W odpowiednich testach uwzględnij brak uprawnień, błędne dane i awarię dostawcy.
- Opisz wymagane ustawienia i migrację danych w instrukcji aktualizacji.
Kod i dokumentacja
Przykład: dodanie wymaganego pola
Załóżmy, że komenda tworząca sprawę serwisową zaczyna wymagać pola priority. Poza formularzem korzystają z niej importy, obsługa zdarzeń i zewnętrzni klienci API. Mogą nadal wysyłać dotychczasowe dane. Istniejące rekordy w bazie również nie mają nowej wartości.
Zmianę można wprowadzić etapami: najpierw pole opcjonalne z uzasadnioną wartością domyślną, potem uzupełnienie rekordów i aktualizacja wywołań, a na końcu obowiązkowe pole. Jeśli wartość domyślna byłaby błędna biznesowo, zwracaj zrozumiały błąd i opisz wymagany sposób migracji.
Kod i dokumentacja
Które zmiany wpływają na inne części systemu?
| Zmiana | Kto z niej korzysta |
|---|---|
| Nazwa lub dane zdarzenia | Procedury obsługi, także zadania utworzone przed wdrożeniem. Podczas aktualizacji mogą wymagać obsługi starszego formatu danych. |
| Nazwa komendy, dane wejściowe lub wynik | Trasy, importy, automatyzacje i narzędzia. Sprawdź ich dotychczasowe wywołania z nową implementacją. |
| Identyfikator uprawnienia | Zapisane ustawienia ról i kontrola dostępu. Zmiana nazwy może odebrać dostęp obecnym użytkownikom. |
| Struktura encji | Istniejące rekordy, zapytania i kolejność wdrożenia. Przygotuj migrację bazy oraz sposób odtworzenia danych. |
Kod i dokumentacja
Narzędzia AI zmieniające dane
Narzędzia AI zmieniające dane korzystają z etapu przygotowania i potwierdzenia operacji. Dodając narzędzie, zachowaj sprawdzanie zakresu, podgląd operacji i wymaganą akceptację. Polecenie w języku naturalnym nie powinno pomijać skonfigurowanego potwierdzenia.
Kod i dokumentacja
Własna aplikacja czy zmiana we frameworku?
Przy własnej funkcji korzystaj ze skryptów i wersji zależności swojej aplikacji. Zmiana w repozytorium produktu musi dodatkowo przejść wymagane tam kontrole i spełnić zasady pakietów. Zgłaszając błąd lub udostępniając przykład, podaj użyte środowisko.