A proper organization of commits to the repository is a fundamental requirement for effective implementation in the case of large e-commerce systems. Every team member should know, understand and use the method of saving changes accepted in the implementation company. Unified and predetermined rules allow for effective searching as well as repairing software errors in situations when they occur. Below I present the basic set of rules in the implementation of Magento adopted at Global4Net.
GENERAL RULES
Commits are sent in English according to the following assumption:
[The area to which the commit refers (Magento page class or range of changes)] The entry for the change applies.
Examples of commit for individual situations:
WHOLE LAYOUT
[layout] An entry describing what the change affects
GENERAL SUBPAGES
Home page changes – [cms-index-index]
Change on the category card – [catalog-category-view]
Change on the product card – [catalog-product-view]
Change on the basket card – [checkout-cart-index]
Change in the ordering process – [checkout-onepage-index]
Change in the ordering process (firecheckout) – [firecheckout-index-index]
Change on the login/registration card – [customer-account-login]
Error subpage – [cms-index-noroute]
Advanced search engine subpage – [catalogsearch-advanced-index]
CUSTOMER PANEL SUBPAGES
Account panel – [customer-account-index]
Account details – [customer-account-edit]
Address book – [customer-address-index]
My orders – [sales-order-history]
My wish list – [wishlist-index-index]
My tags – [tag-customer-index]
My applications – [oauth-customer-token-index]
Subscribe to the newsletter – [newsletter-manage-index]
My products to download – [downloadable-customer-products]
My invitations – [points-invitation-index]
Reward Points – Reward Points – [points-reward-index]
TRANSLATIONS
If we change the translations, we add the second part to the commit [translations]
Example of use – changing the translation of the newsletter area on the home page
[cms-index-index] [translations] Changing newsletter’s subscribe button translation
CHANGES IN MODULES AFTER TRANSFERING TO CORE
We use names from the module administration panel (System -> Configuration -> Advanced), e.g.
[Amasty_Shopby] – changes to the improved wiki module from Amasty
[Mage_Wishlist] – changes in the wishlist
…
CHANGES IN THE ADMINISTRATION PANEL – CORE
We use the [admin] sign for the admin zone and the block name from path hints, e.g.
[admin] [Mage_Adminhtml_Block_Sales_Order] – for changes on the grid with orders in the admin panel