Skip to content

Commit

Permalink
chore: updated instructions to include formatting and checks
Browse files Browse the repository at this point in the history
Signed-off-by: Anthony D. Mays <anthony@morganlatimer.com>
  • Loading branch information
anthonydmays committed Mar 1, 2024
1 parent fcc9ee5 commit f473a1b
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions lesson_02/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,22 @@ To complete this assignment, you must have **Docker** and **VS Code** with the [
For this assignment, you will complete a quiz by modifying a Java application. Within the quiz project, there are tests that you will need to make pass in order to submit your answers. Here are the instructions for completing the assignment:

1. Make sure to sync your fork to pull in the latest changes.
1. Open the project in **VS Code** and make sure to select `Reopen in Container` when prompted.
1. Open the [Lesson2.java][lesson-2-quiz] file located in the [quiz/lesson_02_quiz/src/main/java/com/codedifferently/lesson_02_quiz/][lesson-2-dir] directory.
1. Update the code to provide the correct answers to the given questions.
1. When ready to test, run the following command in the `quiz` sub-directory using the terminal:

2. Open the project in **VS Code** and make sure to select `Reopen in Container` when prompted.
3. Open the [Lesson2.java][lesson-2-quiz] file located in the [quiz/lesson_02_quiz/src/main/java/com/codedifferently/lesson_02_quiz/][lesson-2-dir] directory.
4. Update the code to provide the correct answers to the given questions.
5. This project uses a tool called [Spotless][spotless-link] to check that the code is formatted correctly. Once you are done with your changes, you can automatically fix formatting issues using the following command in the `quiz` sub-directory using the terminal:
```bash
./gradlew spotlessApply
```
6. When ready to test, run the following command in the `quiz` sub-directory using the terminal:
```bash
./gradlew test
./gradlew check
```
6. Once all tests pass, submit your work by creating a pull request (PR).
7. Once all tests pass, submit your work by creating a pull request (PR).


[dev-containers-link]: https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers
[lesson-2-quiz]: quiz/lesson_02_quiz/src/main/java/com/codedifferently/lesson2/Lesson2.java
[lesson-2-dir]: quiz/lesson_02_quiz/src/main/java/com/codedifferently/lesson2/
[test-report]: quiz/lesson_02_quiz/build/reports/tests/test/index.html
[spotless-link]: https://github.com/diffplug/spotless

0 comments on commit f473a1b

Please sign in to comment.