on master help sign in
Updates to contributing.md

1. Made explicit rational behind the libraries in `libs`. 2. Made explicit where contributions shoule be made.

commitfe3d1f7c7966daac736e5e692a56ab017bedc4c4 authorJan de Muijnck-Hughes <jfdm@st-andrews.ac.uk> dateMon 23 Mar 2015, 09:55 (12 years ago) parent9dc7105
1 file changed+14−4
CONTRIBUTING.md+14−4
CONTRIBUTING.md+14−4
@@ -28,18 +28,28 @@ Please clean up any messes that you find, and don't leave behind new messes for
2828## Contributing to the default libraries.
2929
3030Idris ships with a set of packages in `libs/` that is provided as a default library.
31+
32++ `prelude` is the bare minimum required for any Idris program to run.
33++ `base` is tried and tested code that may be useful, and has seen active use in multiple projects.
34++ `contrib` is code that is experimental in design and want to test before possible inclusion in `base`.
35++ `effects` is an implementation of algebraic effects that is packaged alongside Idris.
36+
3137These packages should not be seen as the *standard* as when working with dependent types we do not necessarily know how best to work with dependent types.
3238These packages offer functionality that can be built on top of when constructing Idris programs.
3339
34−One major point to make is that everything in prelude will be imported automatically, unless given
35−the `--noprelude` option.
40+One major point to make is that everything in prelude will be imported automatically, unless given the `--noprelude` option.
3641Likewise, the contents of base are available with no special options.
37−The other two packages that ship with Idris, contrib and effects, require a the use of the `-p` command-line argument to bring their contents into the include path.
42+The other two packages that ship with Idris, contrib and effects, require the use of the `-p` command-line argument to bring their contents into the include path.
3843New contributions should probably be sent to contrib first, so that they can get maintained with the Idris distribution.
3944If they turn out to be widely applicable and useful, they may later be moved into base.
4045
4146As Idris is still being developed we are open to suggestions and changes that make improvements to these default packages.
42−Major changes to the library (or Idris itself) should ideally be discussed first through the projects official channels of communication i.e. the mailing list, github wiki, or IRC, or as a [Dragon Egg](https://github.com/idris-lang/Idris-dev/wiki/Feature-proposals).
47+Major changes to the library (or Idris itself) should ideally be discussed first through the projects official channels of communication:
48+
49+1. The mailing List.
50+1. On our IRC Channel `#idris` on freenode, or
51+1. As a [Dragon Egg](https://github.com/idris-lang/Idris-dev/wiki/Feature-proposals).
52+
4353Developers then seeking to add content to Idris's prelude and default library, should do so through a PR where more discussion's and refinements can be made.
4454
4555We do not want you wasting your time nor duplicating somebody's work!