Skip to content

Project 1 Submission

Below are the steps to "submitting" a completed project, although the code review is only required for 2 out of the 4 projects.

Screenshots

Place all screenshots the screenshots/project-1 directory.

For screenshots 1-3, you may choose to show all results (tests, build, and exception handling) in one screenshot of your console. If you go this route, name the screenshot, project01Success.png.

  1. testsPass.png show all the unit tests passing in the console.

  2. successfulBuild.png show the program builds without errors.

  3. errorHandling.png show the program's error handling. The screenshot must show the following:

    • What happens when an incorrect number of command line arguments are used?
    • What happens when the incorrect file name is entered?

  4. summary.png the summary.txt file after your program analyzes the bigFile.txt.

    • The total number of tokens must be 4468588.

  5. distinct.png the bottom of your distinct_tokens.txt file after analyzing the bigFile.txt.

  6. javaDoc.png show the JavaDoc script running without errors.

Push your code to GitHub

  1. Stage all your changes for the next commit.

    git add .

  2. Commit your code with a meaningful message

    git commit -m "some meaningful message here

  3. Push your code to your remote repository

    git push

GitHub Issue & Reflection

  1. Create a new issue in GitHub, title it: "Project 1 ready for review".
  2. Reflect on Project 1: Copy the below text and paste it into the "Add a description" textarea.

Note on Question #2

Question 2 can be submitted in any format! If you would rather tell your Project 1 story through audio, video, drawings/FigJam, or whatever you have in mind, let me know!

Suggestion: Work on this reflection in another document and copy it all to your issue once complete. 

@kkschumacher

## Project 1 Reflection

#### 1. Are you completing a code review for this project? If yes, place an "X" between the brackets [] to indicate which review you plan to complete.
- [ ] MS Teams
- [ ] Recorded video

#### 2. Tell your Project 1 "story". Describe how it unfolded, from its overall learnings to the obstacles and pitfalls you encountered along the way, whether they made you cringe, caused frustration, or left you exclaiming "oh no!" Your commit history should help you reflect on your project journey. Elaborate on the creative approaches and solutions that took you from "oh no!" to "I got this!". Emphasize the significant takeaways and knowledge you acquired throughout the project's journey.



#### 3. Look back at your commit history. How many git commits did you create during this unit? Do you have meaningful commit messages? Do your commit message show the process and progress through the project? If not, and you have less than 25 commits, make a note to improve this for the next unit. 



#### 4. Now that you have finished your code, look back at your planning document. What about your plan was correct? What was incorrect?



#### 5. List three things you want to focus on improving on in the next unit. Reference the course competencies (located in the syllabus) for assistance in choosing areas to focus on.



#### 6. If you haven’t already watched the challenge presentations for the OOP Challenge, do so now. What new insights or knowledge did you gain from the presentation(s)? What, if any, questions do you have on the topics? Post your insights and questions in the Slack channel as a thread.

Schedule Code Review

See Project 1 Code Review for details on the parts to the code review.

MS Teams

If choosing to do a MS Teams code review, schedule an appointment with me. If there is not a date/time that works for you, please Slack me so we can work to find a time that does work.

  • Schedule a MS Teams Code Review

  • If you need to cancel your code review, you can cancel the automated MS Teams meeting.

  • If you need to reschedule your code review, you can cancel the automated MS Teams meeting and go back to the booking link above.

Recorded Video

  1. If recording a video, please share your 20 minute video with me through Slack.

Making Corrections

If you receive a "Not Yet" mark on your project code, you are encouraged to make corrections to your code.

  1. Using the verbal feedback your instructor gives during the code review or written feedback in GitHub, make the necessary updates to your project code.

  2. Add, commit, and push all your changes before the due date.

  3. Reply to your GitHub Issue and include the list of the changes/corrections you made.

  4. I will review your changes and reply to your issue with any additional feedback.

Finalizing Your Project

One you receive a "Met" mark on your project, it's time to tag your project!

  1. Tag your project as v1.0-project1. See Tagging Your Project for instructions on how to create a git tag.