diff --git a/exercises/practice/hello-world/.docs/instructions.append.md b/exercises/practice/hello-world/.docs/instructions.append.md index bc3e9d9c1..de93adad5 100644 --- a/exercises/practice/hello-world/.docs/instructions.append.md +++ b/exercises/practice/hello-world/.docs/instructions.append.md @@ -1,24 +1,25 @@ # Instructions append -Since this is your first Java exercise, we've included a detailed [Tutorial](#tutorial) that guides you through your solution. Check it out for tips and assistance! +Since this is your first Java exercise, we've included a detailed [Tutorial] that guides you through your solution. Check it out for tips and assistance! ## Tutorial ### Table of Contents -- [Introduction](#introduction) -- [Exercise Structure](#exercise-structure) -- [Solving "Hello, World!"](#solving-hello-world) -- [Step 1: Fix the solution](#step-1-fix-the-solution) -- [Step 2: Run the tests](#step-2-run-the-tests) -- [Step 3: Submitting your first iteration](#step-3-submitting-your-first-iteration) -- [Next steps](#next-steps) +- [Introduction] +- [Exercise Structure] +- [Solving "Hello, World!"] +- [Step 1: Fix the solution] +- [Step 2: Run the tests] +- [Step 3: Submitting your first iteration] +- [Next steps] ### Introduction Welcome to the first exercise on the Java track! -This document is a step-by-step guide to solving this exercise. The instructions should work equally well on Windows, macOS and Linux. +This document is a step-by-step guide to solving this exercise. +The instructions should work equally well on Windows, macOS and Linux. Even if you are already familiar with Java basics, stepping through this guide may be helpful as it will help you understand the output from the tool, Gradle, that we use to compile and test our code, as well as introduce some of the patterns common to all exercises in this track. @@ -26,16 +27,18 @@ Even if you are already familiar with Java basics, stepping through this guide m When you fetch a new Java exercise, you will receive: -- __one or more test files__ (always). These live in the `src/test/java` directory and define a set of tests that our solution must satisfy before we can safely declare that it is working. -- __one or more starter files__ (initially). If provided, these live in the `src/main/java` directory and define shells of the classes you will need in order to solve the current problem. +- __one or more test files__ (always). +These live in the `src/test/java` directory and define a set of tests that our solution must satisfy before we can safely declare that it is working. +- __one or more starter files__ (initially). +If provided, these live in the `src/main/java` directory and define shells of the classes you will need in order to solve the current problem. ### Solving "Hello, World!" You can use our online editor to solve your solution and run the tests, but if you want to solve the problem and run tests locally check these links below: -- [Installing Java](https://exercism.org/docs/tracks/java/installation) -- [Working Locally](https://exercism.org/docs/using/solving-exercises/working-locally) -- [Testing locally on the java track](https://exercism.org/docs/tracks/java/tests) +- [Installing Java] +- [Working Locally] +- [Testing locally on the java track] ### Step 1: Fix the solution @@ -55,14 +58,14 @@ After making corrections and implementing your solution, run the tests again. You can run the tests using the online editor or locally on your machine: - To run the tests in the online editor, click the "Run Tests" button. -- To run the tests locally, check [Testing on the Java track](https://exercism.org/docs/tracks/java/tests) If the tests fails, that's ok! See what the error message is telling you, change your code and test again. When your tests pass, move on to the next step. +- To run the tests locally, check [Testing on the Java track] If the tests fails, that's ok! See what the error message is telling you, change your code and test again, when your tests pass, move on to the next step. ### Step 3: Submitting your first iteration With a working solution that we've reviewed, we're ready to submit it to exercism.org. -You can submit the solution using the online editor or locally using the [Exercism CLI](https://exercism.org/docs/using/solving-exercises/working-locally): +You can submit the solution using the online editor or locally using the [Exercism CLI]: -- To submit the exercise locally, first [install the exercism CLI](https://exercism.org/docs/using/solving-exercises/working-locally) if you haven't already and then submit the files of your solution, e.g: +- To submit the exercise locally, first [install the exercism CLI] if you haven't already and then submit the files of your solution, e.g: ```sh exercism submit @@ -78,19 +81,21 @@ You can submit the solution using the online editor or locally using the [Exerci For a closer look at submitting a solution locally: -- [Submitting locally](https://exercism.org/docs/using/solving-exercises/working-locally) +- [Submitting locally] ### Next steps From here, there are a number of paths you can take. -Regardless of what you decide to do next, we sincerely hope you learn and enjoy being part of this community. If at any time you need assistance do not hesitate to ask for help. +Regardless of what you decide to do next, we sincerely hope you learn and enjoy being part of this community. +If at any time you need assistance do not hesitate to ask for help. Cheers! ### Move on to the next exercise -There are many more exercises you can practice with. Grab the next one! (example for `two-fer`) +There are many more exercises you can practice with. +Grab the next one! (example for `two-fer`) ```sh exercism download --exercise=two-fer --track=java @@ -98,9 +103,12 @@ exercism download --exercise=two-fer --track=java ### Become a mentor -The heart of Exercism are the conversations about coding practices. It's definitely fun to practice, but engaging with others both in their attempts and your own is how you get feedback. That feedback can help point out what you're doing well and where you might need to improve. +The heart of Exercism are the conversations about coding practices. +It's definitely fun to practice, but engaging with others both in their attempts and your own is how you get feedback. +That feedback can help point out what you're doing well and where you might need to improve. -Some submissions will be nearly identical to yours, others will be completely different. Seeing both kinds can be instructive and interesting. +Some submissions will be nearly identical to yours, others will be completely different. +Seeing both kinds can be instructive and interesting. Mentors review submitted solutions for the track they've chosen to mentor to help users learn as much as possible. @@ -112,5 +120,20 @@ The entire of Exercism is Open Source and is a labor of love for over 100 mainta A starting point to jumping in and becoming a contributor can be found [here][Contributing]. +[Tutorial]: #tutorial +[Introduction]: #introduction +[Exercise Structure]: #exercise-structure +[Solving "Hello, World!"]: #solving-hello-world +[Step 1: Fix the solution]: #step-1-fix-the-solution +[Step 2: Run the tests]: #step-2-run-the-tests +[Step 3: Submitting your first iteration]: #step-3-submitting-your-first-iteration +[Next steps]: #next-steps [Mentoring]: https://exercism.org/docs/mentoring [Contributing]: https://github.com/exercism/docs/tree/main/building +[Installing Java]: https://exercism.org/docs/tracks/java/installation +[Working Locally]: https://exercism.org/docs/using/solving-exercises/working-locally +[Testing locally on the java track]: https://exercism.org/docs/tracks/java/tests +[Testing on the Java track]: https://exercism.org/docs/tracks/java/tests +[Exercism CLI]: https://exercism.org/docs/using/solving-exercises/working-locally +[install the exercism CLI]: https://exercism.org/docs/using/solving-exercises/working-locally +[Submitting locally]: https://exercism.org/docs/using/solving-exercises/working-locally