Skip to content

Commit

Permalink
Add CONTRIBUTE file. [doc]
Browse files Browse the repository at this point in the history
  • Loading branch information
trans committed Jan 15, 2014
1 parent 5ba1bae commit 573cd12
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions CONTRIBUTE.md
@@ -0,0 +1,18 @@
# CONTRIBUTING TO FACETS

* Facets methods must have no external dependencies. (The only possible
exception to this is fi we decide to spin functor methods off to a
separate functor gem, but for now that is not happening.)

* Methods must be tested either via a Lemon unit test or a QED demo,
preferrably both. The Lemon unit tests are for testing a method in
detail whereas the QED demos are for demonstrating usage.

* Facets is divided into two parts, *core* and *standard* libraries.
All of the core library is loaded by default when using `require 'facets'`
(actually, almost all). The standard library (sometimes called the *more*
library) must be required per-script.

* Some core methods are included on a *trial* basis, and these are not
necessary loaded automatically with `require 'facets'`.

0 comments on commit 573cd12

Please sign in to comment.