iP:
Level-4
, A-TextUiTesting
, A-CodeQuality
tP:
master
branch of your fork to the master
branch of the upstream repo (https://github.com/nus-cs2113-AY2324S2/ip)[{Your full/partial name or your Github username}] iP
[Richard Mathews Chee] iP
or [Rich ... hee] iP
or [TheRichMat] iP
The PR will update automatically to reflect your latest code every time you push code to your fork. As a result, it provides a convenient way for us to access the current state of all your iP code from one location.
Level-4
, A-TextUiTesting
, A-CodeQuality
This task is worth 2x2=4
participation points.
Step 1 Note these additional guidelines:
Comment
(i.e., not Approve
or Request changes
)Step 2 Do the first PR review as follows.
If the student you have been allocated to review has not created a PR (or the PR has a trivial amount of code), you can review the Backup PR to review provided in the allocation table. Failing both, review another PR allocated to another student in your own tutorial but not in your team.
Tip for future reference: GitHub allows you to filter PRs/Issues using various criteria such as author:AuthorUsername
(example -- see the filters
text box in the target page).
Alternatively, you can use PR labels (if any) to filter PRs/Issues.
FAQ: How many comments should I add? Answer: Depends on the code being reviewed but we expect most PRs would warrant at least 4-5 comments. If the PR is huge, you can stop when you think you've put in a fair amount of time on the job (~15 minutes) and added enough comments for the PR author to receive some value.
If the allocated PR is not suitable, use the same strategy as before to find an alternative PR to review.
Timely completion of the weekly tP tasks can improve the project management component of your tP grade.
As we are still at the early stages of identifying a problem to solve, do not think of the product (i.e., the solution) yet. That is, do not discuss the product features, UI, command format, and implementation details, etc. unless they are pertinent to the user profile or the problem addressed.
Pick a CLI-friendly product domain: Given Recommendation-CLI-First
and Constraint-Typing-Preferred
mentioned in the panels above, it makes sense to pick a product domain that is more suitable for CLI interactions i.e., a product that deals with easy-to-type textual data, needs a small number of data fields, and each data field is short. For example, a blog editor is an unsuitable product domain because it also deals with non-text data (e.g., images, videos) and some data fields are quite long (i.e., paragraphs of text). Similarly, keeping track of extensive employee records may be an unsuitable domain if there are many data fields per employee.