gaspersic/freeCodeCamp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: update formatting for curriculum docs

Browse Source
This commit is contained in:
Mrugesh Mohapatra
2018-10-09 01:17:36 +05:30
parent 3bd8492577
commit a668ad2030
1 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/how-to-work-on-curriculum-challenges.md
View File

@ -1,17 +1,20 @@
# Contributing to Challenges # How to work on curriculum challenges
### Changing on GitHub ### Changing on GitHub
Each challenge is stored in it's own markdown file. That makes it easy to edit challenges right from within GitHub. Each challenge is stored in it's own markdown file. That makes it easy to edit challenges right from within GitHub.
You can make a change without having anything running on your local system. You can make a change without having anything running on your local system.
After you find the file you want to modify within the GitHub interface, click the pencil icon to start editing the file. This will automatically create a fork of the project, if you don't have one already. After you find the file you want to modify within the GitHub interface, click the pencil icon to start editing the file. This will automatically create a fork of the project, if you don't have one already.
You can also clone the project and edit locally on you computer. For help with that, read the main [contributing guide](../CONTRIBUTING.md). You can also clone the project and edit locally on you computer. For help with that, read the main [contributing guide](/CONTRIBUTING.md).
### Challenge Template ### Challenge Template
Here is a template of what the challenge markdown files look like. Here is a template of what the challenge markdown files look like.
````
````md
--- ---
id: Unique identifier (alphanumerical, MongoDB _id) id: Unique identifier (alphanumerical, MongoDB _id)
title: Challenge Title title: Challenge Title
@ -81,10 +84,10 @@ Challenge solution code.
### Useful Links ### Useful Links
* Creating and Editing Challenges: Creating and Editing Challenges:
- [Challenge Style Guide](challenge-style-guide.md) - how to create and format challenges 1. [Challenge Style Guide](style-guide-for-curriclum-challenges.md) - how to create and format challenges
- [Challenge types](https://github.com/freeCodeCamp/learn/blob/a5cb25704168aa37f59a582f0bb5a19b7bd89b46/utils/challengeTypes.js) - what the numeric challenge type values mean (enum). 2. [Challenge types](https://github.com/freeCodeCamp/learn/blob/a5cb25704168aa37f59a582f0bb5a19b7bd89b46/utils/challengeTypes.js) - what the numeric challenge type values mean (enum).
- [Contributing to FreeCodeCamp - Writing ES6 Challenge Tests ](https://www.youtube.com/watch?v=iOdD84OSfAE#t=2h49m55s) - a video following [Ethan Arrowood](https://twitter.com/ArrowoodTech) as he contributes to the old version of the curriculum 3. [Contributing to FreeCodeCamp - Writing ES6 Challenge Tests ](https://www.youtube.com/watch?v=iOdD84OSfAE#t=2h49m55s) - a video following [Ethan Arrowood](https://twitter.com/ArrowoodTech) as he contributes to the old version of the curriculum