Working with commits

While providing your contribution to the Magento code base it is important to accompany it with a meaningful commit message. Meaningful commit message is important to:

1. Help speed up the reviewing process
2. Help us write a good release note
3. Help future developers understand why a particular change was made

We recommend including the github issue number and title, as well as some additional comments that you feel are relevant.

Commit message format

magento/magento2#<issue-number>: <issue-title>
 - <additional comment>

Commit message example

magento/magento2#8618: Apply coupon code button issue on checkout

- fixed issue with assigning coupon_code value from totals

Tips

• If it feels hard to summarize what your commit is, then try splitting it into multiple commits,
• If there is no github issue please feel free to miss out the magento/magento2#<issue-number>: section and just add a meaningful title,
• If you are working on a community project please update the issue part as appropriate, for example, import export should be magento-engcom/import-export-improvements#<issue-number>: