VVC-Software-Development-Workflow.md

 VVC Software Development Workflow
 =================================
 
+The workflow on this page applies to tool adoptions as well as for bug fixes and cleanups.
+
 It is generally advised to familiarize yourself with the usage of **git** and GitLab. Some sources are:
 
 Reading:
@@ -12,8 +14,29 @@ Youtube:
 2) Git Branch Merge: https://www.youtube.com/watch?v=FyAAIHHClqI
 3) Git Remotes: https://www.youtube.com/watch?v=Gg4bLk8cGNo
 
-Register
---------
+Best practices
+--------------
+
+### Comments in commits and merge request
+
+For commits:
+- Make sure to use proper comments in commits. Use one line for the short summary, followed by an empty line and then a detailed description (if necessary) 
+- Gitlab will take over summary and text body into the merge request description, if the branch has only one commit
+
+For merge requests:
+
+- Make sure to set a proper title for the merge request, that allow software coordinators to identify the contents of the request
+- For tool integrations use the document number as a prefix, e.g.: "JVET-M0471: Long deblocking filters" 
+- For bug fixes refer to the bug ID in the mantis tracker, but also add a short summary, e.g. "Fix #178: Avoid referencing encoder parameter in low level MC function"
+- If your merge request is not finalized, mark it as "Work in Progress", by adding "WIP:" to the beginning of the subject line. Add some explanation to the description, why the request in WIP
+
+### Bug reporting
+
+- All bugs should be filed in the bug tracker located at https://jvet.hhi.fraunhofer.de/trac/vvc
+- If a fix is available, the fix should be submitted as merge request. A reference to the merge request should be added to the bug report.
+
+GitLab-Registration
+-------------------
 
 Got to the main page at https://vcgit.hhi.fraunhofer.de and select "Register" to register for an account. Fill in all required data.