1.0.0 • Published 8 years ago

colobus v1.0.0

Weekly downloads
3
License
MIT
Repository
github
Last release
8 years ago

Description

Create a library of at least 20 commonly used Lodash methods with documentation and commenting using ES2015. Publish the code as a package to NPM.

Context

This goal is important for:

  • learning JavaScript
  • understanding how developer write higher-level code for others to use
  • understanding ES2015

This code will be used by other developers to make their jobs easier.

The questions that this project will raise are:

  • how do we write packages that are easy to understand and simple to use out of the box?
  • how to publish a package to NPM?

Specifications

Required

  • Includes a list of commonly used methods to rewrite in ES2015 (minimum 20).
  • Includes a README that describes each method and provides an example of use.
  • Package is published with NPM.
  • Includes tests for all methods described.
  • The artifact produced is properly licensed, preferably with the MIT license.

Quality

  • Each individual function is self-documenting using intuitive names with a matching file name. (e.g., function map corresponds to map.js)
  • Each function is imported into a single file.
  • The main file is organized imperatively via script (see _c.js).
  • The documentation is organized imperatively via script (see joinDocs.js and docs.md).
  • Branch names and commit messages are descriptive.

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.