Guided Task: Conclusion
You should have a green check on Jenkins and your project (including your System Test Plan and generated Javadoc) should be pushed to the remote. Now’s the time to double check all your work!
Submission is More Than Jenkins!
CRITICAL: Complete Submission Requirements
A green check on Jenkins is NOT sufficient for a complete submission. You must verify ALL of the following items are complete:
✓ Jenkins shows green check (appropriate project structure, no test failures, no static analysis notifications)
✓ All code pushed to GitHub (verify on github.com)
✓ System Test Plan document pushed to project_docs/ folder
✓ Complete Javadoc pushed (entire doc/ directory with all files)
✓ AI usage documented in README.md (even if you did not use AI)
✓ Submission deadline met (visible on GitHub commit history)
Missing ANY of these items will result in point deductions, even if Jenkins is green. Use the checklist below to verify completion.
Final Tasks
Before you complete your final submission to GitHub, you should ensure the following:
- You have met the requirements and design for the
WolfSchedulerproject - You have a green check on Jenkins (No test failures and no static analysis notifications)
- All JUnit tests pass with a green bar (0 errors). There should be no modifications to the teaching staff tests.
- All Black Box Tests pass AND you’ve pushed the system test plan document to the remote GitHub (check this by going to https://github.com and verifying the document is there)
- There are no SpotBug notifications
- There are no PMD notifications
- There are no CheckStyle notifications
- All code is commented with meaningful comments
- Javadoc webpages are generated with the latest comments
- That you meet all rubric items for the assignment
- AI usage documented in
README.md(see details below)
Make sure that all code is pushed to GitHub by the assignment deadline. There are deductions for any late work up to 48 hours.
AI Usage Documentation
You must document your use (or non-use) of AI tools in your repository’s README.md file:
- If you used AI tools (Google Gemini in Learning Mode) Syllabus Expectations:
- Provide the full prompt, including any code that you provided to the AI tool
- Provide the full response
- Provide a reflection on how you integrated the response in your project
- If you did NOT use AI tools:
- Add this statement to
README.md: “I did not use any AI tools to complete this assignment.”
- Add this statement to
- Where to add this:
- Edit
README.mdin the root of your repository - Add a section titled “## AI Usage” or “## Generative AI”
- Place your documentation there
- Edit
This is a required deliverable and failure to include it will result in a deduction. Academic integrity requires transparent disclosure of AI tool usage.
Grading Rubric
All assignments have a rubric that you can use to estimate your grade. Use the Jenkins feedback and your black box test results to estimate the grade for Guided Project 1.
Your Wolf Scheduler Guided Project 1 will be evaluated on the following items:
Overall Rubric
| Phase | Grade Item | Points | Details |
|---|---|---|---|
|
Teaching Staff JUnit Tests | 40 | Pass all of the provided JUnit tests. |
|
Teaching Staff System Tests | 40 | There are 13 test cases at 2 points a piece. To pass a test case, your program must show the appropriate actual results for the provided test inputs. An additional 1 point per test is for reporting the actual results of your program in the system test plan - even if the test is failing. The last point is for submitting your document in the correct location (i.e., the `project_docs/` folder in your Eclipse project). |
|
Javadoc Contents | 10 | See the Javadoc rubric, below. The rubric will be applied per class and will be averaged by the number of classes. |
|
Javadoc Generation | 5 | Javadoc tool was used to generate the HTML version of the API, which matches the current version of the in-code Javadoc. |
|
Style | 5 | Any PMD, CheckStyle, or SpotBugs Scary or Scariest notifications will result in a one point deduction, up to the available points. |
| Total Points | 100 |
Deductions
| Grade Item | Points | Details |
|---|---|---|
| Misnamed file or incorrect project structure | -5 | Incorrect names of files or incorrect project structure. This can include problems when importing the project to Eclipse for acceptance testing, incorrect location of the system test file, etc. |
| Late | varies | You will lose 1 point for every 2 hours your projects is late, up to 24 points in 48 hours. |
Javadoc Rubric
| Item | Strong - 3 points | Adequate - 2 points | Inadequate - 1 point |
|---|---|---|---|
| Class comments | Class comments fully describe the behavior and abstraction of the class. Author tag is there. | Class comments lack some details of the class’ behavior and abstraction. Author tag may be missing. | Class comments are there but provide no detail about the class’ purpose. Author tag may be missing. |
| Method comments | Method comments fully describe the behavior of the method. Param, return, and throws (for both checked and unchecked exceptions) tags are there and fully specified as appropriate for the method. | Method comments lack some details about the method’s behavior. Param and return tags are there, but not fully specified. | Method comments are there but provide no detail about the method’s purpose. Param and return tags are missing. |
| Field comments | Field comments fully describe the field’s state as part of the class’ abstraction | Field comments lack some details about the field’s state as part of the class. | Field comments are minimal and provide no detail about the field’s purpose. |
| Spelling | No spelling errors | A few minor spelling errors that do not distract from the content. | Many spelling errors that distract from the content |
| Grammar | No grammatical errors | A few grammatical errors that do not distract from the content | Many grammatical errors that distract from the content. |
GitHub Resources:
Submit!
Use the feedback from Jenkins to make changes to your code. Any time you make a change, push to GitHub and check the Jenkins results.
- Make sure that all fields, methods, and constructors are commented.
- Resolve all static analysis notifications.
- Fix test failures.
- Commit and push your code changes with a meaningful commit message. Label your commit with “[Implementation]” for future you!
- Check Jenkins results for a green check! Fix any Jenkins issues.
Congratulations!
You’ve finished the first Guided Project and a good portion of the WolfScheduler requirements. Great work on reviewing prerequisite materials and using the new suite of development tools for CSC 216/217! You’re off to a great start. Take time to celebrate your accomplishment!
