This site is not ready yet! The updated version will be available soon.

Peer EvaluationsGrade Breakdown


Tools


Tools Used: Learning Management System

This module website is the main source of information for the module. In addition, we use LumiNUS for some things (e.g., webcasts, announcements, file submissions, grade book, ...).

Tool Used: GitHub (for Code Hosting)

You are required to use GitHub as the hosting and collaboration platform of your project (i.e., to hold the Code repository, Issue Tracker, etc.).

Preparation:

Create a GitHub account (if you don't have one yet), as explained in the panel below.

Relevant: [Admin Appendix E - GitHub: Creating an Account ]

More info: See Appendix E - Using GitHub.

Tool Used: Git (for Revision Control)

You are required to use Git. Other revision control software are not allowed. The recommended GUI client for Git is SourceTree, but you may use any other, or none.

Preparation:

Install Git and a Git GUI client on your computer.
SourceTree comes with bundled with Git i.e., if you install SourceTree, you get both Git and a GUI client in one shot.

Set Git user.name: We use various tools to analyze your code. For us to be able to identify your commits, we encourage you to set your Git user.name in all computers you use to a sensible string that uniquely identifies you. For example, you can to GitHub username or your full name as your Git username. If this user name is not set properly or if you use multiple user names for Git, our tools might miss some of your work and as a result you might not get credit for some of your work.

After installing Git in a computer, you can set the Git username as follows:

  1. Open a command window that can run Git commands (e.g., Git bash window)
  2. Run the command git config --global user.name YOUR_GITHUB_USERNAME (omit the --global flag to limit the setting to the current repo repo)
    e.g., git config --global user.name JohnDoe

More info about setting Git username is here.

Tools Used: for Communication

  • The preferred channels for module-related communication is the forum on GitHub https://github.com/nus-cs2103-AY1920S2/forum/issues (not the LumiNUS forum)
  • When communicating with instructors, use the forum. Use private channels (e.g., emails, private messages, face-to-face, private chat groups) only when the forum is not suitable. Rationale: 1. More classmates can benefit from the discussions, 2. It is also safer because the prof can monitor information you receive for accuracy.
  • You are encouraged to help others in the forum (e.g., share tips, help with technical problems). We consider such sharing when giving out A+ grades and when recruiting tutors.

Preparation:

We encourage you all to,

  • watch the forum to get alerts when new issues/comments are posted

Tool Used: Intellij IDE

You are recommended to use Intellij IDEA for module-related programming work. While the use of Intellij is not compulsory, note that module materials are optimized for Intellij. Use other IDEs at your own risk.

Preparation:

  • Install the IDE in your computer. You may use the Intellij community edition (free) or the ultimate edition (free for students).
  • If you have an older version of the IDE, we recommend updating to the latest version (i.e., 2019 edition).

Tool Used: RepoSense (for Analyzing Code Authorship)

We will be using a tool called RepoSense to make it easier for you to see (and learn from) code written by others, and to help us see who wrote which part of the code.

RepoSense report screenshot
Figure: RepoSense Report Features

Viewing the current status of code authorship data:

  • The report generated by the tool will be made available at tP Code Dashboard at some point in the semester. The feature that is most relevant to you is the Code Panel (shown on the right side of the screenshot above). It shows the code attributed to a given author.
  • Click on your name to load the code attributed to you (based on Git blame/log data) onto the code panel on the right.
  • If the code shown roughly matches the code you wrote, all is fine and there is nothing for you to do.

2. If the code does not match the actual authorship:

  • Here are the possible reasons for the code shown not to match the code you wrote:

    • the git username in some of your commits does not match your GitHub username.
    • the actual authorship does not match the authorship determined by git blame/log e.g., another student touched your code after you wrote it, and Git log attributed the code to that student instead

  • In those cases, you can provide more information to RepoSense to rectify the situation, in the following way:

For simple cases such as the following, you can create a PR to update our config files here. The meaning of the config files are given in the RepoSense user guide.

  • missing some commits due to using multiple git user.names
  • some commits/files need to be omitted from the analysis

For more complicated needs, follow the instructions below this box. If you are not sure which option to use, please post in the forum to ask.

  • Install RepoSense (see the Getting Started section of the RepoSense User Guide)
  • Use the two methods described in the RepoSense User Guide section Configuring a Repo to Provide Additional Data to RepoSense to provide additional data to the authorship analysis to make it more accurate.
  • If you add a config.json file to your repo (as specified by one of the two methods),
    • Please use the exact partial name from here as the display name.
      e.g., "displayName": "ABDUL ... JAVID",
    • If your commits have multiple author names, specify all of them
      e.g., "authorNames": ["theMyth", "theLegend", "The Gary"]
    • Update the line config.json in the .gitignore file of your repo as /config.json so that it ignores the config.json produced by the app but not the _reposense/config.json.
  • If you add @@author annotations, please follow the guidelines below:

Adding @@author tags to indicate authorship

  • After you are satisfied with the new results (i.e., results produced by running RepoSense locally), push the config.json file you added and/or the annotated code to your repo. We'll use that information the next time we run RepoSense (we run it at least once a week).
  • If you choose to annotate code, minimize annotating code chunks smaller than a method. We do not grade code snippets too small to be read meaningfully.
  • If you encounter any problem when doing the above or if you have questions, please post in the forum.

We recommend you ensure your code is RepoSense-compatible by v1.3


Peer EvaluationsGrade Breakdown