Właściwa organizacja commitów do repozytorium to podstawowy warunek skutecznego wdrożenia w przypadku dużych systemów ecommerce. Każdy członek zespołu powinien znać, rozumieć i stosować przyjęty w firmie wdrożeniowej sposób zapisywania zmian. Jednolite i z góry określone zasady pozwalają na skuteczne wyszukiwanie, a także naprawę błędów oprogramowania w sytuacjach ich wystąpienia. Poniżej prezentuję podstawowy zbiór reguł przy realizacjach Magento przyjęty w firmie Global4Net.

 

ZASADY OGÓLNE
Commity wysyłane są w języku angielskim wg następującego założenia:
[Strefa do której commit się odnosi (klasa strony Magento lub określenie zakresu zmian)] Wpis czego zmiana dotyczy.
Przykłady commitów dla poszczególnych sytuacji:

CAŁY LAYOUT
[layout] Wpis czego zmiana dotyczy

PODSTRONY OGÓLNE
Zmiany strony głównej - [cms-index-index]
Zmiana na karcie kategorii – [catalog-category-view
Zmiana na karcie produktu – [catalog-product-view]
Zmiana na karcie koszyka – [checkout-cart-index]
Zmiana w procesie zamówienia – [checkout-onepage-index]
Zmiana w procesie zamówienia (firecheckout) – [firecheckout-index-index]
Zmiana na karcie logowania/rejestracji – [customer-account-login]
Podstrona błędu – [cms-index-noroute]
Podstrona wyszukiwarki zaawansowanej – [catalogsearch-advanced-index]

PODSTRONY PANELU KLIENTA
Panel konta – [customer-account-index]
Dane konta – [ustomer-account-edit]
Książka adresowa – [customer-address-index]
Moje zamówienia – [sales-order-history]
Moja lista życzeń – [wishlist-index-index]
Moje tagi – [tag-customer-index]
Moje aplikacje – [oauth-customer-token-index]
Subskrybcja newsletter – [newsletter-manage-index]
Moje produkty do pobrania – [downloadable-customer-products]
Moje zaproszenia – [points-invitation-index]
Punkty I nagrody (Reward Points) – [points-reward-index]

TŁUMACZENIA
W przypadku zmiany tłumaczeń dopisujemy drugi człon do commita [translations]
Przykład użycia – zmiana tłumaczenia obszaru newlettera na stronie głównej
[cms-index-index] [translations] Changing newsletter’s subscribe button translation

ZMIANY W MODUŁACH PO PRZENIESIENIU DO CORE
Stosujemy nazwy z panelu administracyjnego modułów (System -> Konfiguracja -> Zaawansowane), np.
[Amasty_Shopby] – zmiany w module improved nawigation od Amasty
[Mage_Wishlist] – zmiany w liście życzeń


ZMIANY W PANELU ADMINISTRACYJNYM – CORE
Stosujemy oznaczenie [admin] dla strefy admina oraz nazwę bloku z path hints, np.
[admin][Mage_Adminhtml_Block_Sales_Order] – dla zmian na gridzie z zamówieniami w panelu admina