diff --git a/docs/how-to-work-on-coding-challenges.md b/docs/how-to-work-on-coding-challenges.md index b618d50d93..7cade04186 100644 --- a/docs/how-to-work-on-coding-challenges.md +++ b/docs/how-to-work-on-coding-challenges.md @@ -12,14 +12,22 @@ You can also clone the project and edit locally on your computer. For help with ### Challenge Template -Here is a template of what the challenge markdown files look like. +Below is a template of what the challenge markdown files look like. + +**Notes:** + +1. In the below sections, examples of `{ext}` are: + * `html` - HTML/CSS + * `js` - JavaScript + * `jsx` - JSX + +2. For the `Tests` section below, `text` and `testString` should be valid YAML strings. `testString` can be a stringified function or expression possibly using Chai asserts. ````md --- id: Unique identifier (alphanumerical, MongoDB_id) title: Challenge Title challengeType: 0 -guideUrl: 'url of guide article' videoUrl: 'url of video explanation' --- @@ -32,40 +40,45 @@ A Description of the challenge and what is required to pass
Instructions about what exactly needs to be done.
+ ## Tests
``` yml -- text: Should return "foo". - testString: 'A stringified function using Chai asserts' +tests: + - text: Should return "foo" + testString: 'A stringified function possibly using Chai asserts' ```
-
+## Challenge Seed +
-```js -Code displayed in the editor by default. +
+ +```{ext} +Code displayed in the editor by default. + +This is a required section for the challenge. ```
### Before Test -
+
-```js -Test setup code. +```{ext} +Optional Test setup code. ```
-
- ### After Test -
+
-```js -Test tear down code. +```{ext} +Optional Test tear down code. ```
@@ -75,8 +88,8 @@ Test tear down code. ## Solution
-```js -Challenge solution code. +```{ext} +// solution required ```