Week 7 [Mon, Sep 28th] - Project
iP:
- Add Increment:
A-MoreOOP - Add Increments as PRs:
Level-8,Level-9,A-JavaDoc - Set up a product website
- Submit the final version Fri, Oct 2nd 2359
tP:
- Ensure you know tP expectations
- Plan the next iteration (
v1.0) - Start the next iteration
iP
2 Add Increments as PRs: Level-8, Level-9, A-JavaDoc
If your code already has Javadoc comments for all public methods, you can simply add the A-JavaDoc tag to the current commit and skip the A-JavaDoc increment.
4 Submit the final version Fri, Oct 2nd 2359
- Double-check to confirm your iP meets the criteria for full marks, as given in the panel below.
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 on a computer that has Java 25. To avoid version compatibility issues, we strongly recommend the following approach:
- Open a terminal window and navigate to the root of your project folder.
- Run the
java -versioncommand to confirm the terminal is using Java 25. - Run the
./gradlew clean shadowJarcommand to create the JAR file.
- Create the JAR file in one of these ways:
Do the following smoke tests to ensure the JAR file works (reason: a similar flow will be used when grading your iP).
- Copy the JAR file to an empty folder and test it from there. This should surface issues with hard-coded file paths.
When running the JAR file for smoke testing, instead of double-clicking the JAR file, do the following: open a terminal → navigate to the JAR location → run thejava -jar "JAR_FILE_NAME"command. - Pass the JAR file to team members and ask them to do a test drive. Assuming some of your team members use a different OS from yours, this should verify if the app is cross-platform.
If you don't have ready access to a specific OS, you can ask others to help smoke-test it by posting a smoke-testing request in the forum -- 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.
Create a new release on GitHub (e.g.,
v0.2) and upload the JAR file.
Your GitHub username : 
Note: Type your GitHub username in the blank above so that we can customize sample commands to fit you.
- There is no need for the release to be tagged
A-Releasespecifically. - Ensure your release appears at https://github.com/[[username: JohnDoe]]/ip/releases. Use an incognito browser window when checking this URL, to ensure the release is visible to the public.
- The JAR file should be uploaded as an 'asset', with the
.jarextension. Do not put it inside a zip file. - Avoid uploading multiple JAR files to this release, as this can create extra work for the evaluators. Upload only the JAR file you want to be evaluated as your iP.
- If you have multiple iP releases on GitHub, we take the JAR file from the latest release, irrespective of the release name or the tag used. So, feel free to create more releases if you happen to update the code after creating the initial release.
The JAR, User Guide, and the code released via GitHub constitute the iP final submission; there is no separate submission on Canvas.
tP: Plan the Iteration
1 Ensure you know tP expectations
- If you haven't done so already, make sure you know individual and team expectations of the tP
2 Plan the next iteration (v1.0)
- 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.
- 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.
- 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 creating and assigning issues to yourself and to the corresponding milestone. The panel below explains the full workflow we prescribe you to follow in the tP.