- Learn about the project
- Set up prerequisites
- Set up the project in your computer
- Add Increments while committing frequently:
Level-0,Level-1,Level-2,Level-3,Level-4,A-TextUiTesting,Level-5,Level-6,A-EnumsFri, Jan 26th 1600
The iP (and the tP) undergoes changes after each semester. As such, teething issues are a possibility. If you encounter any problem while doing the iP/tP, please post in the forum so that we can take necessary actions.
We discourage you from doing project tasks allocated to future weeks. Reasons: In order to help you gain (and also to better simulate real projects), we want the project work to be and span a longer period, rather than to be done as a short burst.
Reminder: as per iP grading criteria, some increments need to to be done in each week for you to get full marks. That is, clumping all the iP work into a short burst of work will not earn you full marks.
Please follow instructions carefully. Any deviations can cause our grading scripts to miss your work (and result in you not getting credit for the work).
Deadline:
Note the typical deadline weekly project tasks:
As per the above, you have until the next weekly briefing to finish this week's iP tasks, but if you fail to do so, we won't penalize you if you can catch up within one more week after that deadline.
1 Learn about the project
- Read the following two sections, if you haven't done so already:
2 Set up prerequisites
- Ensure you have followed the Preparation sections of the following course tools:
3 Set up the project in your computer
Read through this week's topics before starting the project.
If you encounter technical problems while doing the iP, follow the guidelines given below:
- Fork https://github.com/nus-cs2103-AY2324S2/ip, while noting the points below:Keep the fork name as
ipor else our grading scripts will not be able to detect it. You can change the fork name to something else after the semester (and the grading) is over e.g., after receiving your grade for the course.Untick the[ ] Copy the master branch onlyoption so that you get a copy of the full repo. - Enable the issue tracker of your fork (Go to
Settingsof your fork, scroll to theFeaturessection, and tick theIssuescheckbox). Reason: at times we post feedback on your issue tracker.If the issue tracker is enabled, you should be able to visit the following URLhttps://github.com/{your_user_name}/ip/issues
e.g.,https://github.com/johnDoe/ip/issues - Clone the fork onto your computer.
- Set up the project in your IDE as explained in the README file, if you plan to use an IDE for the project.
4 Add Increments while committing frequently: Level-0, Level-1, Level-2, Level-3, Level-4, A-TextUiTesting, Level-5, Level-6, A-Enums Fri, Jan 26th 1600
Implement the given below in the given order.
Keep in mind ...
- From this point onward, commit code at important points. Minimally, commit after completing each increment.
Remember not to commit.classfiles and any other file that should not be revision controlled.
From this point onward, after completing each increment,
git tagthe commit with the exact increment ID e.g.,Level-2,A-TextUiTestingGit tags are not the same as Git commit messages.git pushthe code to your forkGit doesn't push tags unless you specifically ask it to. After pushing a tag to your fork, you should be able to see that tag by visitinghttps://github.com/YOUR_USER_NAME/REPO_NAME/tagse.g., https://github.com/se-edu/addressbook-level3/tagsIf you encounter issues connecting Sourcetree with your GitHub account, refer to this Sourcetree Tutorial.
Remember to take note of our plagiarism policies, if you haven't done so already: