TheOdinProject · VHadyak · Aug 7, 2021 · Aug 7, 2021 · Aug 7, 2021 · Aug 7, 2021
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,54 @@
+---
+name: Bug Report
+about: Create a report to help us improve something that is not working correctly
+title: "Bug - :"
+labels: "Status: Needs Review, Type: Bug"
+assignees: ""
+---
+
+<!-- Thank you for taking the time to submit a bug report to The Odin Project. In order to get issues closed in a reasonable amount of time, you must include a baseline of information about the bug in question. Please read this template in its entirety before filling it out to ensure that it is filled out correctly. -->
+
+Complete the following REQUIRED checkboxes:
+-   [ ] I have thoroughly read and understand [The Odin Project Contributing Guide](https://github.com/TheOdinProject/theodinproject/blob/main/CONTRIBUTING.md)
+-   [ ] The title of this issue follows the `Bug - location of bug: brief description of bug` format, e.g. `Bug - Exercises: File type incorrect for all test files`
+
+The following checkbox is OPTIONAL:
+<!-- Completing this checkbox does not guarantee you will be assigned this issue, but rather lets us know you are interested in working on it. -->
+-   [ ] I would like to be assigned this issue to work on it
+
+<hr>
+
+**1. Description of the Bug:**
+<!-- A clear and concise description of what the bug is. Include any screenshots that may help show the bug in action. -->
+
+
+**2. How To Reproduce:**
+<!--
+What steps one might need to take in order to reproduce this bug, e.g.:
+1. Log in
+2. Visit a lesson page
+3. Click the complete button
+4. The complete button does not update
+-->
+
+
+**3. Expected Behavior:**
+<!--
+A brief description of what you expected to happen, e.g.:
+1. Log in
+2. Visit a lesson page
+3. Click the complete button
+4. The complete button updates correctly
+ -->
+
+
+**4. Desktop/Device:**
+<!-- The more information you are able to provide, the better. -->
+-   Device: <!-- [e.g. iPhone6] -->
+-   OS: <!-- [e.g. iOS] -->
+-   Browser: <!-- [e.g. chrome, safari] -->
+-   Version: <!-- [e.g. 22] -->
+
+**5. Additional Information:**
+<!-- Any additional information about the bug. -->
+
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,38 @@
+---
+name: Feature Request
+about: Suggest a new feature or enhancement for this project
+title: ""
+labels: "Status: Needs Review"
+assignees: ""
+---
+    
+<!-- Thank you for taking the time to submit a new feature request to The Odin Project. In order to get issues closed in a reasonable amount of time, you must include a baseline of information about the feature/enhancement you are proposing. Please read this template in its entirety before filling it out to ensure that it is filled out correctly. -->
+
+Complete the following REQUIRED checkboxes:
+-   [ ] I have thoroughly read and understand [The Odin Project Contributing Guide](https://github.com/TheOdinProject/theodinproject/blob/main/CONTRIBUTING.md)
+-   [ ] The title of this issue follows the `location for request: brief description of request` format, e.g. `Exercises: Add exercise on XYZ`
+
+The following checkbox is OPTIONAL:
+<!-- Completing this checkbox does not guarantee you will be assigned this issue, but rather lets us know you are interested in working on it. -->
+-   [ ] I would like to be assigned this issue to work on it
+
+<hr>
+
+**1. Description of the Feature Request:**
+<!-- 
+A clear and concise description of what the feature or enhancement is, including how it would be useful/beneficial or what problem(s) it would solve. 
+-->
+
+
+**2. Acceptance Criteria:**
+<!--
+A list of checkbox items that explain the requirements needed to be met to resolve this request, e.g.:
+- [ ] A theme toggle is present on the dashboard
+- [ ] Clicking the theme toggle changes between light and dark
+- [ ] A user's theme choice persists after leaving the website
+ -->
+
+
+**3. Additional Information:**
+<!-- Any additional information about the feature request, such as a link to a Discord discussion, screenshots, etc. -->
+
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,30 @@
+<!-- Thank you for taking the time to contribute to The Odin Project. In order to get a pull request (PR) closed in a reasonable amount of time, you must include a baseline of information about the changes you are proposing. Please read this template in its entirety before filling it out to ensure that it is filled out correctly. -->
+
+Complete the following REQUIRED checkboxes:
+<!-- While editing this template, replace the whitespace between the square brackets with an 'x', e.g. [x] -->
+-   [ ] I have thoroughly read and understand [The Odin Project Contributing Guide](https://github.com/TheOdinProject/theodinproject/blob/main/CONTRIBUTING.md)
+-   [ ] The title of this PR follows the `location of change: brief description of change` format, e.g. `01_helloWorld: Update test cases`
+
+Complete the following checkboxes ONLY IF they are applicable to your PR. You can complete them later if they are not currently applicable:
+-   [ ] I have ensured any exercise files included in this PR have passed all of their tests
+
+<hr>
+
+**1. Because:**
+<!--
+If this PR closes an open issue, replace the XXXXX below with the issue number, e.g. Closes #2013. Or if the issue is in another TOP repo replace the #XXXXX with the URL of the
F438
 issue, e.g. Closes https://github.com/TheOdinProject/curriculum/issues/XXXXX
+
+Otherwise, provide a clear and concise reason for your pull request, e.g. what problem it solves or what benefit it provides. If this PR is related to, but does not close, another issue or PR, you can also link it as above without the 'Closes' keyword, e.g. "Related to #2013".
+ -->
+Closes #XXXXX
+
+
+**2. This PR:**
+<!--
+A bullet point list of one or more items outlining what was done in this PR to solve the problem(s) or implement the feature/enhancement.
+ -->
+
+
+**3. Additional Information:**
+<!-- Any additional information about the PR, such as a link to a Discord discussion, etc. -->
+
diff --git a/helloWorld/README.md → 01_helloWorld/README.md b/helloWorld/README.md → 01_helloWorld/README.md
@@ -13,7 +13,7 @@ Let's look at the spec file first:
 const helloWorld = require('./helloWorld');
 
 describe('Hello World', function() {
-  test('says hello world', function() {
+  test('says "Hello, World!"', function() {
     expect(helloWorld()).toEqual('Hello, World!');
   });
 });
@@ -38,7 +38,7 @@ Go ahead and see if you can make the test pass by editing the return value of th
 
 Just to make sure, in case you're confused at this point, the test is telling you that running the function `helloWorld` should return the phrase `Hello, World!`.  Punctuation and capitalization definitely matter here, so double check that if the test still isn't passing.
 
-this is what the final function should look like:
+This is what the final function should look like:
 ```javascript
 const helloWorld = function() {
   return 'Hello, World!'

diff --git a/helloWorld/helloWorld.js → 01_helloWorld/helloWorld.js b/helloWorld/helloWorld.js → 01_helloWorld/helloWorld.js
diff --git a/helloWorld/helloWorld.spec.js → 01_helloWorld/helloWorld.spec.js b/helloWorld/helloWorld.spec.js → 01_helloWorld/helloWorld.spec.js
diff --git a/repeatString/README.md → 02_repeatString/README.md b/repeatString/README.md → 02_repeatString/README.md
@@ -6,6 +6,10 @@ Write a function that simply repeats the string a given number of times:
 repeatString('hey', 3) // returns 'heyheyhey'
 ```
 
+This function will take two arguments, `string` and `num`.
+
+*Note:* The exercises after this one will not have arguments provided as this one does - you will need to provide them yourself from now on. So read each exercise's README carefully to see what kinds of arguments will be expected.
+
 You will notice in this exercise that there are multiple tests (see in file `repeatString.spec.js`). Only the first test is currently enabled. So after making sure that this first one passes, enable the others one by one by deleting the `.skip` from the `test.skip()` function.
 
 
@@ -17,11 +21,9 @@ You will notice in this exercise that there are multiple tests (see in file `rep
 
 - Create a variable to hold the string you're going to return, create a loop that repeats the given number of times and add the given string to the result on each loop.
 
-- If running `npm test repeatString.spec.js` returns results similar to the below:
+- If running `npm test repeatString.spec.js` returns results similar to the below, make sure you have enabled the rest of the tests, as described in the instructions above.
 
 ```
 Test Suites: 1 passed, 1 total
 Tests:       6 skipped, 1 passed, 7 total
 ```
-
-- Make sure you have enabled the rest of the tests (see above).
diff --git a/repeatString/repeatString.js → 02_repeatString/repeatString.js b/repeatString/repeatString.js → 02_repeatString/repeatString.js
@@ -2,4 +2,5 @@ const repeatString = function() {
 
 };
 
+// Do not edit below this line
 module.exports = repeatString;
diff --git a/repeatString/repeatString.spec.js → 02_repeatString/repeatString.spec.js b/repeatString/repeatString.spec.js → 02_repeatString/repeatString.spec.js
@@ -28,7 +28,7 @@ describe('repeatString', () => {
     const number = Math.floor(Math.random() * 1000)
     /*The .match(/((hey))/g).length is a regex that will count the number of heys
     in the result, which if your function works correctly will equal the number that
-    was randomaly generated. */
+    was randomly generated. */
     expect(repeatString('hey', number).match(/((hey))/g).length).toEqual(number);
   });
   test.skip('works with blank strings', () => {

diff --git a/reverseString/README.md → 03_reverseString/README.md b/reverseString/README.md → 03_reverseString/README.md
diff --git a/reverseString/reverseString.js → 03_reverseString/reverseString.js b/reverseString/reverseString.js → 03_reverseString/reverseString.js
@@ -2,4 +2,5 @@ const reverseString = function() {
 
 };
 
+// Do not edit below this line
 module.exports = reverseString;
diff --git a/reverseString/reverseString.spec.js → 03_reverseString/reverseString.spec.js b/reverseString/reverseString.spec.js → 03_reverseString/reverseString.spec.js
diff --git a/removeFromArray/README.md → 04_removeFromArray/README.md b/removeFromArray/README.md → 04_removeFromArray/README.md
diff --git a/removeFromArray/removeFromArray.js → 04_removeFromArray/removeFromArray.js b/removeFromArray/removeFromArray.js → 04_removeFromArray/removeFromArray.js
@@ -2,4 +2,5 @@ const removeFromArray = function() {
 
 };
 
+// Do not edit below this line
 module.exports = removeFromArray;
diff --git a/removeFromArray/removeFromArray.spec.js → 04_removeFromArray/removeFromArray.spec.js b/removeFromArray/removeFromArray.spec.js → 04_removeFromArray/removeFromArray.spec.js
diff --git a/sumAll/README.md → 05_sumAll/README.md b/sumAll/README.md → 05_sumAll/README.md
diff --git a/sumAll/sumAll.js → 05_sumAll/sumAll.js b/sumAll/sumAll.js → 05_sumAll/sumAll.js
@@ -2,4 +2,5 @@ const sumAll = function() {
 
 };
 
+// Do not edit below this line
 module.exports = sumAll;
diff --git a/sumAll/sumAll.spec.js → 05_sumAll/sumAll.spec.js b/sumAll/sumAll.spec.js → 05_sumAll/sumAll.spec.js
diff --git a/leapYears/README.md → 06_leapYears/README.md b/leapYears/README.md → 06_leapYears/README.md
diff --git a/leapYears/leapYears.js → 06_leapYears/leapYears.js b/leapYears/leapYears.js → 06_leapYears/leapYears.js
@@ -2,4 +2,5 @@ const leapYears = function() {
 
 };
 
+// Do not edit below this line
 module.exports = leapYears;
diff --git a/leapYears/leapYears.spec.js → 06_leapYears/leapYears.spec.js b/leapYears/leapYears.spec.js → 06_leapYears/leapYears.spec.js
diff --git a/tempConversion/README.md → 07_tempConversion/README.md b/tempConversion/README.md → 07_tempConversion/README.md
diff --git a/tempConversion/tempConversion.js → 07_tempConversion/tempConversion.js b/tempConversion/tempConversion.js → 07_tempConversion/tempConversion.js
@@ -6,6 +6,7 @@ const ctof = function() {
 
 };
 
+// Do not edit below this line
 module.exports = {
   ftoc,
   ctof

diff --git a/tempConversion/tempConversion.spec.js → 07_tempConversion/tempConversion.spec.js b/tempConversion/tempConversion.spec.js → 07_tempConversion/tempConversion.spec.js
diff --git a/calculator/README.md → 08_calculator/README.md b/calculator/README.md → 08_calculator/README.md
diff --git a/calculator/calculator.js → 08_calculator/calculator.js b/calculator/calculator.js → 08_calculator/calculator.js
@@ -22,6 +22,7 @@ const factorial = function() {
 
 };
 
+// Do not edit below this line
 module.exports = {
   add,
   subtract,

diff --git a/calculator/calculator.spec.js → 08_calculator/calculator.spec.js b/calculator/calculator.spec.js → 08_calculator/calculator.spec.js
diff --git a/palindromes/README.md → 09_palindromes/README.md b/palindromes/README.md → 09_palindromes/README.md
diff --git a/palindromes/palindromes.js → 09_palindromes/palindromes.js b/palindromes/palindromes.js → 09_palindromes/palindromes.js
@@ -2,4 +2,5 @@ const palindromes = function () {
 
 };
 
+// Do not edit below this line
 module.exports = palindromes;
@@ -17,6 +17,6 @@ describe('palindromes', () => {
     expect(palindromes('Animal loots foliated detail of stool lamina.')).toBe(true);
   });
   test.skip('doesn\'t just always return true', () => {
-    expect(palindromes('ZZZZ car, a man, a maraca.')).toBe(false);
+    expect(palindromes('ZZZZ car, a man, a maracaz.')).toBe(false);
   });
 });
@@ -2,4 +2,5 @@ const fibonacci = function() {
 
 };
 
+// Do not edit below this line
 module.exports = fibonacci;
@@ -2,4 +2,5 @@ const getTheTitles = function() {
 
 };
 
+// Do not edit below this line
 module.exports = getTheTitles;
@@ -2,4 +2,5 @@ const findTheOldest = function() {
 
 };
 
+// Do not edit below this line
 module.exports = findTheOldest;
@@ -14,7 +14,7 @@ caesar('A', 1) // simply shifts the letter by 1: returns 'B'
 
 the cipher should retain capitalization:
 ```javascript
-caesar('Hey', 5) // returns 'Mjd;
+caesar('Hey', 5) // returns 'Mjd'
 ```
 
 should _not_ shift punctuation:

@@ -2,4 +2,5 @@ const caesar = function() {
 
 };
 
+// Do not edit below this line
 module.exports = caesar;
@@ -1,27 +1,32 @@
-These are a series of JavaScript exercises intended to be used alongside the curriculum at 'The Odin Project'. They start simple and easy but get more complex and involved as you progress through them.
+# JavaScript Exercises
 
-There will eventually be a suggested order of completion, but at this time since we are still in the process of creating more exercises the order is subject to change and has not yet been specified. However, there are a few exercises that make a good "starting point". Feel free to at least start with these:
+These JavaScript exercises are intended to complement the JavaScript content on The Odin Project (TOP). They should only be done when instructed during the course of the curriculum.
 
-1. Hello World
-2. Repeat String
-3. Reverse String
+**Note:** The `generator-exercise` file is not actually an exercise; it is a script that generates exercises. It was created to help efficiently write these exercises.
+
+## Contributing
+
+If you have a suggestion to improve an exercise, an idea for a new exercise, or notice an issue with an exercise, please feel free to open an issue after thoroughly reading our [contributing guide](https://github.com/TheOdinProject/theodinproject/blob/main/CONTRIBUTING.md) in our main TOP repo.
 
 ## How To Use These Exercises
-Before you start you should have a few things installed on your machine:
-1. **NPM**. To check if you have NPM installed, type `npm --version` in your terminal. If you get back `Command 'npm' not found, but can be installed with:`, do NOT follow the instructions in the terminal to install with `apt-get`. (This causes permission issues.) Instead, install Node with NVM by following the instructions [here](https://github.com/TheOdinProject/curriculum/blob/master/foundations/installations/installing_node.md).
-2. **A copy of this repository**. Copies of repositories on your machine are called clones. If you need help cloning, you can learn how [here](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository).
-3. **Jest**. After cloning this repository to your local machine, go into the newly created directory (`cd javascript-exercises`) and run `npm install`. This will install Jest and set up the testing platform based on our preconfigured settings.
 
-Each exercise includes 3 files: a markdown file with a description of the task, an empty (or mostly empty) JavaScript file, and a set of tests. To complete an exercise, you'll need to go to the exercise directory with `cd exerciseName` in the terminal and run `npm test exerciseName.spec.js`. This should run the test file and show you the output. When you first run a test, it will fail. This is by design! You must open the exercise file and write the code needed to get the test to pass. Some of the exercises have test conditions defined in their spec file that are defined as 'test.skip' compared to 'test'. This is purposeful. After you pass your first 'test', you will change the next 'test.skip' to an 'test' and test your code again. You'll do this until all conditions are satisfied. **ALL TESTS MUST PASS AT THE SAME TIME.**
+1. Fork and clone this repository. To learn how to fork a repository, see the GitHub documentation on how to [fork a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo). 
+    * Copies of repositories on your machine are called clones. If you need help cloning to your local environment you can learn how from the GitHub documentation on [cloning a repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository).
+2. Before you start working on any execises, you should first ensure you have the following installed:
+    * **NPM**. You should have installed NPM already in our [Installing Node.js](https://www.theodinproject.com/lessons/foundations-installing-node-js) lesson. Just in case you need to check, type `npm --version` in your terminal. If you get back `Command 'npm' not found, but can be installed with:`, **do not follow the instructions in the terminal** to install with `apt-get` as this causes permission issues. Instead, go back to the installation lesson and install Node with NVM by following the instructions there.
+    * **Jest**. After cloning this repository to your local machine and installing NPM, go into the newly created directory (`cd javascript-exercises`) and run `npm install`. This will install Jest and set up the testing platform based on our preconfigured settings.
+3. Each exercise includes 3 files: a markdown file with a description of the task, an empty (or mostly empty) JavaScript file, and a set of tests. To complete an exercise, you'll need to go to the exercise directory with `cd exerciseName` in the terminal and run `npm test exerciseName.spec.js`. This should run the test file and show you the output.
+    * When you first run a test, it will fail. This is by design! You must open the exercise file and write the code needed to get the test to pass. 
+4. Some of the exercises have test conditions defined in their spec file as `test.skip` compared to `test`. This is purposeful. After you pass one `test`, you will change the next `test.skip` to `test` and test your code again. You'll do this until all conditions are satisfied. **All tests must pass at the same time**, and you should not have any `test.skip` instances by the time you finish an exercise.
+5. Once you successfully finish an exercise, check TOP's `solutions` branch to compare it with yours. 
+   * You should not be checking the solution for an exercise until you finish it!
+   * Keep in mind that TOP's solution is not the only solution. Generally as long as all of the tests pass, your solution should be fine.
+6. Do not submit your solutions to this repo, as any PRs that do so will be closed without merging.
 
 **Note**: Due to the way Jest handles failed tests, it may return an exit code of 1 if any tests fail. NPM will interpret this as an error and you may see some `npm ERR!` messages after Jest runs. You can ignore these, or run your test with `npm test exerciseName.spec.js --silent` to supress the errors.
 
 The first exercise, `helloWorld`, will walk you through the process in-depth.
 
-## Solutions
-
-Solutions for these exercises can be found in this repo on the 'solutions' branch.
-
-## A quick note!
+## Debugging
 
-The exercise `generator-exercise` is not actually an exercise; it is a script that generates exercises. It was created to help efficiently write these exercises.
+To debug functions, you can run the tests in the Visual Studio Code debugger terminal. You can open this by clicking the "Run and Debug" icon on the left or pressing `ctrl + shift + D`, then clicking JavaScript Debug Terminal. You will be able to set breakpoints as you would in the Chrome DevTools debugger. You can run `npm test exerciseName.spec.js` to then execute your code up until your breakpoint and step through your code as necessary. **NOTE**: To take advantage of the debugger, you **MUST** run the script in the debugger terminal, not the bash or zsh terminal.
@@ -2,4 +2,5 @@ function pigLatin(string) {
 
 };
 
-  module.exports = pigLatin;
+// Do not edit below this line
+module.exports = pigLatin;
@@ -2,4 +2,5 @@ const snakeCase = function() {
 
 };
 
+// Do not edit below this line
 module.exports = snakeCase;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,5 @@ const repeatString = function() {

		};

		// Do not edit below this line
		module.exports = repeatString;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,5 @@ const reverseString = function() {

		};

		// Do not edit below this line
		module.exports = reverseString;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,5 @@ const removeFromArray = function() {

		};

		// Do not edit below this line
		module.exports = removeFromArray;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,5 @@ const sumAll = function() {

		};

		// Do not edit below this line
		module.exports = sumAll;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,5 @@ const leapYears = function() {

		};

		// Do not edit below this line
		module.exports = leapYears;
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,6 +6,7 @@ const ctof = function() { @@
     };
+    // Do not edit below this line
     module.exports = {
       ftoc,
       ctof
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,5 @@ const palindromes = function () {

		};

		// Do not edit below this line
		module.exports = palindromes;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,5 @@ const fibonacci = function() {

		};

		// Do not edit below this line
		module.exports = fibonacci;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,5 @@ const getTheTitles = function() {

		};

		// Do not edit below this line
		module.exports = getTheTitles;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,5 @@ const findTheOldest = function() {

		};

		// Do not edit below this line
		module.exports = findTheOldest;