Information for Week 10

[ccristina]

Dear Students, Please take note of the following:

---

A. Week 9 Project and Tutorial Check the website’s Project tab under weeks 10 for required submissions before the tutorial day, 23:59 (https://nus-cs2103-ay1819s2.github.io/cs2103-website/schedule/week10/). Note that you are required to:

• follow the instructions found under Project mid v1.3: https://nus-cs2103-ay1819s2.github.io/cs2103-website/admin/project-w10-mid-v13.html. You will receive automatically-generated feedback from our bot. Use this feedback to improve for graded milestone v1.3.

• attempt the exercises and read the information under Topics and Tutorial tabs for week 10 before attending the tutorial.

  B. RepoSense

• We use a new tool called RepoSense to identify your contributions to the project.

  • The tool is setup for the module and the report is available under the project-dashboard link.

• Ensure your code is RepoSense compatible. Instructions here.

• Follow the user guide for RepoSense and fix the issues, if you don't see your contributions detected.

---

C. FAQ:

1. My contributions are not detected in the Reposense report, why?

   1. Check:
      1. Have you set the user.name to your GitHub user name that you provided in the premodule survey?
      2. Have you used different git user name while doing the work? Run git log command on the command line/terminal and look for the Author field.
   2. If the above are correct, you may want to provide a config file to give additional details to Reposense (check the Reposense documentation mentioned above)
      1. You need to commit the config file before running Reposense, else the config won't be picked up by the tool.
   3. Do note: if you include a config file, entries pertaining to all members of the team must be in the config file.

2. I have done everything given in 1, but I still can't see my contributions. How to resolve?

   1. Use @@author tags to identify your code contribution in the source files.
   2. Follow the instructions given in the Reposense documentation for this

3. I did 1 & 2, however, I cannot still see my contributions. Help!!

   1. Usually, most cases will be taken care of by 1 and 2 above.
   2. In case your contributions are still not detected, please post the issue on this forum, we will get the reposense team to take a look.

4. How frequently is the Reposense report generated?

   1. Reposense is configured to run the report every Monday. i.e., the report is generated weekly.

5. My friend and I worked on a piece of code together, but only my friend committed. Now how?

   1. Use @@author tags to indicate chunks of the file that is your contribution. Arrive at a consensus with your friend/teammate before claiming part of the code as yours.

6. What is considered good contribution?

   1. Speaking from code-quality evaluation perspective, you need to have contiguous code chunks in your contribution (e.g., some full classes, some significantly long full methods).

   2. If the code is fragmented (e.g., you only added one additional field to a class, and entire code has fragmented one-two lines that work with the additional field you creates) it becomes hard to grade the code quality.

Best regards, Cristina.