Giter Club home page Giter Club logo

challenge-template's Introduction

General Assembly Logo

Challenge Template

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.

Prerequisites

  • 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.

Instructions

  1. Fork and clone this repository.
  2. Change into the new directory.
  3. Install dependencies.
  4. Create and checkout a new branch to work on.
  5. 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.

Requirements

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.

Bonus

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.

challenge-template's People

Contributors

jrhorn424 avatar

Watchers

James Cloos avatar Carla Mays avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.