create a styleguide from @brndbr's sample style guide
This commit is contained in:
1
app.js
1
app.js
@ -235,6 +235,7 @@ app.get('/install-screenhero', resourcesController.installScreenHero);
|
||||
app.get('/javascript-in-your-inbox', resourcesController.javaScriptInYourInbox);
|
||||
app.get('/guide-to-our-nonprofit-projects', resourcesController.guideToOurNonprofitProjects);
|
||||
app.get('/chromebook', resourcesController.chromebook);
|
||||
app.get('/styleguide', resourcesController.styleguide);
|
||||
app.get('/deploy-a-website', resourcesController.deployAWebsite);
|
||||
app.get('/gmail-shortcuts', resourcesController.gmailShortcuts);
|
||||
app.get('/control-shortcuts', resourcesController.controlShortcuts);
|
||||
|
@ -109,6 +109,12 @@ module.exports = {
|
||||
});
|
||||
},
|
||||
|
||||
styleguide: function styleguide(req, res) {
|
||||
res.render('resources/styleguide', {
|
||||
title: 'A Styleguide for Contributing to our Bonfires'
|
||||
});
|
||||
},
|
||||
|
||||
jqueryExercises: function jqueryExercises(req, res) {
|
||||
res.render('resources/jquery-exercises', {
|
||||
title: 'jQuery Exercises'
|
||||
|
26
views/resources/styleguide.jade
Normal file
26
views/resources/styleguide.jade
Normal file
@ -0,0 +1,26 @@
|
||||
extends ../layout
|
||||
block content
|
||||
.jumbotron.text-left
|
||||
h1.hug-top.text-center Bonfire Style Guide
|
||||
h3 Writing Bonfire challenges is a great way to exercise your own problem solving and testing abilities. It is a simple three step process.
|
||||
h4
|
||||
ol
|
||||
li Fill out the generator form and test your challenge: 
|
||||
a(href="http://www.freecodecamp.com/bonfire-challenge-generator") http://www.freecodecamp.com/bonfire-challenge-generator
|
||||
li Once you have confirmed a working bonfire challenge in the generator, copy and paste the the fields into the JSON generator: http://www.freecodecamp.com/bonfire-json-generator
|
||||
li Copy the JSON, fork the freecodecamp repository, and submit a pull request with your addition to the bonfires.json: 
|
||||
a(href="https://github.com/FreeCodeCamp/freecodecamp/blob/master/seed_data/bonfires.json") https://github.com/FreeCodeCamp/freecodecamp/blob/master/seed_data/bonfires.json
|
||||
h3 Name
|
||||
p Name your challenge
|
||||
h3 Difficulty
|
||||
p Attempt to rate difficulty compared against existing bonfire challenges.
|
||||
h3 Description
|
||||
p Separate paragraphs with a line break. Only the first paragraph is visible prior to a user clicking the "More information" button.
|
||||
p All necessary information must be included in the first paragraph. Write this first paragraph as succinct as possible. Subsequent paragraphs should offer hints or details if needed.
|
||||
p If your subject matter warrants deeper understanding, you may link to Wikipedia.
|
||||
h3 Challenge Seed
|
||||
p This is where you set up what will be in the editor when the camper starts the bonfire.
|
||||
h3 Tests
|
||||
p These tests are what bring your challenge to life. Without them, we cannot confirm the accuracy of a user's submitted answer. Choose your tests wisely.
|
||||
p Bonfire tests are written using the Chai.js assertion library. Please use the should and expect syntax for end user readability. As an example of what not do to, many of the original Bonfire challenges are written with assert syntax and many of the test cases are difficult to read.
|
||||
p If your bonfire question has a lot of edge cases, you will need to write many tests for full coverage. If you find yourself writing more tests than you desire, you may consider simplifying the requirements of your bonfire challenge. For difficulty level 1 through 3, you will generally only need 2 to 4 tests.
|
Reference in New Issue
Block a user