This site is from a past semester! The current version will be here when the new semester starts.

Week 7 [Fri, Feb 23rd] - Project

iP:

  1. Add Increment: A-MoreOOP
  2. Add Increments as PRs: Level-8, Level-9, A-JavaDoc
  3. Set up a product website
  4. Submit the final version Fri, Mar 8th 2359

tP:

  1. Set up the project repo during the tutorial
  2. Plan the next iteration

iP

1 Add Increment: A-MoreOOP

  • As before, commit, tag, and push, after each increment.
Duke A-MoreOOP: Use More OOP

Why more OOP?

2 Add Increments as PRs: Level-8, Level-9, A-JavaDoc

  • Note how to merge PRs:

  • Practice using parallel git branches and PRs, as explained below:
  1. First, do each increment as a parallel branch (follow the branch naming convention you followed earlier branch-Level-8 etc.), but do not merge any.
  2. Then, push each branch to your fork, and create a PR within your fork (i.e., from the increment branch to the master branch). Be careful not to create a PR to the upstream repo. If you did create such a PR by mistake, no worries, just close it yourself.

  1. Now, merge one of the PRs and update the remaining PRs accordingly, as given below:
    1. Merge one of the PRs on GitHub. Remember to choose the Create merge commit option when merging.
    2. The above step will cause the master branch of your local repo to fall behind that of your fork. Therefore, you need to sync the local master with the remote master branch. One way to do that is to switch to the local master branch and then pull the the updated master branch from your fork e.g.,
      $ git checkout master
$ git pull origin master
    3. Note how the remaining un-merged branches are no longer in sync with the latest master. To rectify, merge the master branch to each of them. Resolve merge conflicts, if any.
    4. Push the updated branches to your fork. The PRs will update automatically to reflect the updated branch.
    5. As before, tag the merge commit in the master branch and push the tag to your fork.
  2. Merge the remaining PRs using a procedure similar to the above.
Duke Level-8: Dates and Times optional
Duke Level-9: Find
Duke A-JavaDoc: JavaDoc

3 Set up a product website

  • Add a brief User Guide (UG)
Duke A-UserGuide: User Guide

4 Submit the final version Fri, Mar 8th 2359

  • Soft deadline: midnight before the tutorial
  1. Double-check to confirm your iP meets the criteria for for full marks:

Admin iP - Grading

  1. Create a new jar file
    • Create the JAR file in one of these ways:
      • If you have added a GUI or using third-party libraries: use Gradle.
      • Else: you can use IntelliJ.
    • The JAR file should be cross-platform and should work in a computer that has Java 11.
  2. Do the following smoke tests to ensure the jar file works (reason: a similar flow will be used when grading your iP).
    1. Copy the jar file to an empty folder and test it from there. This should surface issues with hard-coded file paths.
    2. Pass the jar file to team members and ask them to do a test drive. Assuming some of your team members' OS differ from yours, this should verify if the app is cross-platform.
      If you don't have ready access to a specific OS, post a link to your JAR in the forum and ask others to help with the smoke testing -- some of them will even appreciate the opportunity to help a classmate.
      Note that concepts you encounter while doing course project tasks (e.g., smoke testing) are in the scope of the final exam.
  3. Create a new release on GitHub (e.g., v0.2) and upload the JAR file.
    • Recommended to refrain from uploading multiple JAR files as this can cause extra work for the evaluators.
Duke A-Release: Release

tP: Get ready for iterations

1 Set up the project repo during the tutorial

  • Set up the team org, the team repo, and individual forks as explained below:

2 Plan the next iteration

  • Plan the next iteration. As you know, you should follow the breadth-first iterative process. Therefore, first you must decide what functionalities should be in the product if you had only two weeks to implement it. You have done that already when you chose user stories for v1.0, translated that to features, and even drafted the UG based on those features. You can tweak that plan further at this point if you wish, given that you now have some idea of how fast the team can work when using the prescribed workflow.
    • Aim to produce a working MVP at the end of this iteration even if the functionalities are not polished (polishing can be done in a later iteration).
    • Avoid depth-first implementations: "I'll do the back-end part of feature X in this iteration" is not acceptable as that is not in the spirit of breadth-first iterative process. Remember, we are pretending this to be the last iteration; why would you implement the back-end part of a feature in the last iteration?
      It is OK to add simpler versions of bigger features, but not OK to add partial features that can't be used yet.
    • [Recommended, Optional] Break the iteration into two mini iterations as follows:

Splitting v1.0 into two mini iterations

  • v1.0: the first working version of your product, to be delivered by the mid-milestone (i.e., in about one week). As this is an internal milestone, the exact deadline is upto your team.
  • v1.0b: an even more functional version of the product, to be delivered by the end of the full iteration (i.e., in two weeks)

This goal of this 'optimization' is to reduce the risk of an . As a side benefit, it also gives you more opportunities to practice iteration planning.

The reason for naming the earlier milestone as v1.0 is so that even if you fail to finish the second one, you can still get credit for reaching v1.0 (which is the milestone tracked by grading scripts) -- think of the first iteration as minimal deliverables for v1.0 and the second one as containing do-if-there-is-time improvements.

Each mini iteration should deliver a working product, not just do half of the tasks planned for the full iteration. Otherwise, it defeats the purpose of this optimization.

  • Divide the work among the team members i.e., the work required for the current iteration.
  • Reflect the above plan in the issue tracker by assigning the corresponding issues (create new issues if necessary) to yourself and to the corresponding milestone. For example, the user story pertaining to the increment show a placeholder for photo, showing a generic default image should be assigned to Jake and to milestone v1.0