doc/src/110_DevelopmentRules.adoc

== Development Rules

=== Commit comments

Prefix every commit with the Bugzilla ID if there is one, e.g. your commit message would be “518433: made some changes”.


=== Tasks in the code

TODO / FIXME and other tasks have to follow this naming  schema:

    // {TASK_NAME} {my_committer_id}, {yyyy-MM-dd}: {my_comment}

e.g. 
    
    // TODO mkoller, 2017-11-14: Currently only the first Adapter is indexed.

You can do that manually or you can import the following snippet In the Eclipse IDE  via +
Preferences ->Java -> Editor -> Templates 

    <!-- Import: Eclipse IDE -> Window -> Prefernces -> Java -> Editor Templates -> Import -->
    <!-- User Variable: add to eclipse.ini -> "-Duser.name=<my name>" →
    <templates>
        <template autoinsert="true" context="java" deleted="false" description="" enabled="true"        name="TODO">// TODO ${user}, ${d:date('yyyy-MM-dd')}: 
       </template>
      <template autoinsert="true" context="java" deleted="false" description="" enabled="true" name="FIXME">// FIXME ${user}, ${d:date('yyyy-MM-dd')}:
       </template>
    </templates>




Usage in code: "TOD"+ [Ctrl+Space]

You have to set your Eclipse user to your committer ID:
edit the file eclipse.ini and set the parameter:
-Duser.name=your_eclipse_committer_id

=== Working with committer feature branches

Committer Feature Branches are special branches a committer can create and delete. These branches have a dedicated naming scheme: +

  ${my_committer_id}/my_branch. 

Only for those references under refs/heads (and refs/tags) with your Committer ID you will be able to delete the branch afterwards.

* To create a branch: create the branch with the name scheme -> ${my_committer_id}/my_branch

* To delete a branch in Eclipse: Project → Team → Remote → Push …
** “Next” on first wizard screen
** Select branch to delete in “Add delete ref specification”
** Click “Add Spec” (the branch is now listed in “Specifications for push”
** “Finish”

* When integrating your branch into the dev branch:
** Checkout the dev branch
** Merge your feature branch into the dev branch, but with having Git a merge commit created although it was a fast-forward merge
git merge --no-ff your_feature_branch
** Push the dev branch to Gerrit

*Note:* +
 Without the no-ff option Gerrit refuses to accept the push due to “no new changes”.