- Start implementing v1.0
- Add some JUnit Tests
Intro to tP Week 8
Things to note:
COMMON MISTAKE: Not following the convention for Git commit message subject.
Caution: This is very hard to rectify later, after PR containing the commits have been merged. Reason: While Git allows editing past commits, it changes their timestamp, which affects your weekly code contribution stats (which are factored into evaluating the consistency of your coding work over the project duration).
COMMON MISTAKE: Not following the required phrasing style for the first sentence of Java method header comments.
COMMON MISTAKE: Forgetting to do each PR from a separate branch (i.e., send PR from the master branch) of your fork. This error means your PR will not be considered as following the forking workflow correctly.
1 Start implementing v1.0
You may code from any of the below to be used in your tP, provided you give credit to the source (and do not claim such code as yours).
- The iP code of any of your team members, or of any other person in the course.
- Code from AddressBook-Level2 or any code used in course activities e.g., personbook
Start implementing v1.0, by adding code in small steps, while working in parallel, aiming to produce a VERY simple working version after one week, and a bit more functional version at the end of iteration (i.e., after two weeks).
See the panel below the project workflow we prescribe for the tP.
2 Add some JUnit Tests
We recommend that each person adds some JUnit tests to test their tP code.
Some examples from AddressBook-Level2:
seedu.addressbook.common.Utils.java
Tests:seedu.addressbook.common.UtilsTest.java
Note how the test class is in the same package as the SUT (although in a different folder). Advantage: the test class has access to all non-private members of the SUT, including package private members.- SUT:
seedu.addressbook.parser.Parser.java
Tests:seedu.addressbook.parser.ParserTest.java
Note how some of the test methods follow a different naming convention e.g.,parse_emptyInput_returnsIncorrect(). Cross-check the coding standard to confirm if this naming convention is allowed. - SUT:
seedu.addressbook.data.AddressBook.java
Tests:seedu.addressbook.data.AddressBookTest.java