From 48a6370b1fddcd5895c44140f9c17a9c3b51b7b0 Mon Sep 17 00:00:00 2001 From: brutzman <brutzman@nps.edu> Date: Wed, 17 May 2023 10:33:29 -0700 Subject: [PATCH] improved student assignment guidance --- assignments/README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/assignments/README.md b/assignments/README.md index c7693bf050..186c15a0d7 100644 --- a/assignments/README.md +++ b/assignments/README.md @@ -36,14 +36,20 @@ All MV3500 cohorts have source code collected under a common Netbeans project. 4. Name all of your files starting with your last name, e.g. **LastnameProgram.java** **LastnameScreenshot.png** etc. 5. Be sure that names match for **LastnameProgram.java** and the class name, i.e. **public class LastnameJava** 6. Be sure to start each .java source file with correct package name, for example: - 1. package MV3500Cohort2021JulySeptember.homework1; -7. The Run and Debug context menus should be available for you to test your .java source. -8. Be sure to Commit (with description) and Push Upstream, as discussed above. + * package MV3500Cohort2022MayJune.homework1; + * package MV3500Cohort2022MayJune.homework2; etc. +7. Add a copy of **package-info.java** file to your directory, if you use NetBeans then package name is correct. +8. Check the javadoc by going to [build.xml](build.xml) and running target **javadoc.custom* +9. Be sure to Commit (with description) and Push Upstream, as discussed above. After committing and pushing, you can now verify that your files are been shared by checking the website: * https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/tree/master/assignments/src/MV3500Cohort2023MarchJune +A good practice is to note your changes in a **README.md** file. +For nontrivial projects, you will also need to add a UML flow diagram and a +UML timing sequence diagram. Visio has templates for UML diagrams, drawings +with another tool or hand sketches are fine. Clarity is key. ## References -- GitLab