- Learn about the project
- Set up prerequisites
- Set up the project in your computer
- Add Increments (+ commit, tag, push):
Level-0,Level-1,Level-2,Level-3before next lecture
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 module tools:
3 Set up the project in your computer
- Read through this week's topics before starting the project.
- Fork https://github.com/nus-tic4001-AY2122S1/ip.
- 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 encounter technical problems, follow the guidelines given below in seeking help:
FAQ about iP increments
- Q. How are the iP git tags used in grading?
A. A git tag is a self-declaration that you think you are done with the iP increment. We take your word for it. We don't check the code to see if you have actually done the said increment. Therefore, it is just a mechanism for you to self-declare progress and for us to monitor that progress declarations. - Q. What if I discovered a bug after I finished an increment?
A. Go ahead and fix it in a subsequent commit. There is no need to update the previous commit or move the corresponding tag to the new commit. As we do not test your code at every tag, earlier bugs will not affect your grade as long as they are fixed later. Similarly, feel free to improve the code of previous increments later. - Q. I did multiple increments in the same commit. How to fix?
A. You can add the corresponding tags to the same commit.
Optionally, if you haven't pushed the commit to the fork yet, you can try to figure out how to split that commit into multiple commits. - Q. My iP increments are not detected by the dashboard because I forgot to push my tags earlier. What now?
A. Not to worry. Just push the tags now. They will be detected by the dashboard at the next update. There is no penalty if mistakes are detected and fixed soon after. - Q. Oh no! I made a mistake in my tag/branch name.
A. It's OK; correct it now.
4 Add Increments (+ commit, tag, push): Level-0, Level-1, Level-2, Level-3 before next lecture
- 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.