diff --git a/developer/contributing.rst b/developer/contributing.rst index 5c9798d2..57f81bc0 100644 --- a/developer/contributing.rst +++ b/developer/contributing.rst @@ -118,25 +118,23 @@ If the issue is present on Github, use following commit style: .. code-block:: - [module/file/feature] Short description # + [feature/change/fix/chores] Short description # Long description here. - Fixes # + Closes # Here's a real world commit message example from `one of our modules -`_: +`_: .. code-block:: - [admin] Fixed VPN context in preview #57 + [fix] Fixed perennial "modified" state #213 - Fortunately it was just a frontend JS issue. - The preview instance was getting the UUID of the Device - object instead of the Config object, and that prevented - the system from finding the associated VPN and fill the - context VPN keys correctly. + The status of Config objects will only be updated if + the checksum changes, whether it's because of a + change in the config, device or any related templates. - Fixes #57 + Closes #213 Moreover, keep in mind the following guidelines: