forked from rubyworks/facets
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
18 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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'`. | ||
|