Use this template to structure your READMEs for diagnostics.
Be sure to include a recent LICENSE
and Markdown linter
configuration (.remarkrc
). Also, include an appropriate
.gitignore
; these are usually found in specific technology templates, for
example js-template.
- Topics with which developers should be familiar with.
- Prerequisites are "just-in-time", so if I have a prerequisite that mentions Sass, I would not need to include CSS as a prerequisite.
- Links to previous materials are often useful.
- In a challenge, it is useful to link to reference material, such as talk repositories.
- Fork and clone this repository.
- Change into the new directory.
- Install dependencies.
- Create and checkout a new branch to work on.
- Fulfill the listed requirements.
Starter code is available in lib/challenge.js
. A pull
request is not required, but it is necessary if you want a code review.
You may wish to refer to FAQs related to forking, cloning.
Describe behavioral requirements as you'll be using them in tests. That is, list requirements in language that describes how the written code will be used, not how it will be written, with the exception of constraints you may wish to place on implementation. It's a good idea to include the below paragraph verbatim.
You should be running grunt nag
before diagnosing any bugs, since it finds
some of the most common sources of errors. After grunt nag
passes, you should
run grunt test
to run the included tests. Tests will tell you whether of not
you've met these requirements.
Bonuses are described after the requirements, if included. They should be worked on only after passing requirements.
Sometimes, we ask questions that promote thinking critically about code.
Source code distributed under the MIT license. Text and other assets copyright General Assembly, Inc., all rights reserved.