Tools

Adding @@author tags indicate authorship

• Mark your code with a //@@author {yourGithubUsername}. Note the double @.
  The //@@author tag should indicates the beginning of the code you wrote. The code up to the next //@@author tag or the end of the file (whichever comes first) will be considered as was written by that author. Here is a sample code file:

  //@@author johndoe
  method 1 ...
  method 2 ...
  //@@author sarahkhoo
  method 3 ...
  //@@author johndoe
  method 4 ...
  

• If you don't know who wrote the code segment below yours, you may put an empty //@@author (i.e. no GitHub username) to indicate the end of the code segment you wrote. The author of code below yours can add the GitHub username to the empty tag later. Here is a sample code with an empty author tag:

  method 0 ...
  //@@author johndoe
  method 1 ...
  method 2 ...
  //@@author
  method 3 ...
  method 4 ...
  

• The author tag syntax varies based on file type e.g. for java, css, fxml. Use the corresponding comment syntax for non-Java files.
  Here is an example code from an xml/fxml file.

  <!-- @@author sereneWong -->
  <textbox>
    <label>...</label>
    <input>...</input>
  </textbox>
  ...
  

• Do not put the //@@author inside java header comments.
  👎

  /**
    * Returns true if ...
    * @@author johndoe
    */
  

  👍

  //@@author johndoe
  /**
    * Returns true if ...
    */
  

What to and what not to annotate

• Annotate both functional and test code There is no need to annotate documentation files.

• Annotate only significant size code blocks that can be reviewed on its own e.g., a class, a sequence of methods, a method.
  Claiming credit for code blocks smaller than a method is discouraged but allowed. If you do, do it sparingly and only claim meaningful blocks of code such as a block of statements, a loop, or an if-else statement.

  • If an enhancement required you to do tiny changes in many places, there is no need to annotate all those tiny changes; you can describe those changes in the Project Portfolio page instead.
  • If a code block was touched by more than one person, either let the person who wrote most of it (e.g. more than 80%) take credit for the entire block, or leave it as 'unclaimed' (i.e., no author tags).
  • Related to the above point, if you claim a code block as your own, more than 80% of the code in that block should have been written by yourself. For example, no more than 20% of it can be code you reused from somewhere.
  • GitHub has a blame feature and a history feature that can help you determine who wrote a piece of code.

• Do not try to boost the quantity of your contribution using unethical means such as duplicating the same code in multiple places. In particular, do not copy-paste test cases to create redundant tests. Even repetitive code blocks within test methods should be extracted out as utility methods to reduce code duplication. Individual members are responsible for making sure code attributed to them are correct. If you notice a team member claiming credit for code that he/she did not write or use other questionable tactics, you can email us (after the final submission) to let us know.

• If you wrote a significant amount of code that was not used in the final product,

  • Create a folder called {project root}/unused
  • Move unused files (or copies of files containing unused code) to that folder
  • use //@@author {yourGithubUsername}-unused to mark unused code in those files (note the suffix unused) e.g.

  //@@author johndoe-unused
  method 1 ...
  method 2 ...
  

  Please put a comment in the code to explain why it was not used.

• If you reused code from elsewhere, mark such code as //@@author {yourGithubUsername}-reused (note the suffix reused) e.g.

  //@@author johndoe-reused
  method 1 ...
  method 2 ...
  

• You can use empty @@author tags to mark code as not yours when RepoSense attribute the to you incorrectly.

  • Code generated by the IDE/framework, should not be annotated as your own.

  • Code you modified in minor ways e.g. adding a parameter. These should not be claimed as yours but you can mention these additional contributions in the Project Portfolio page if you want to claim credit for them.