git.iko.soy/Idris-dev
on 385dcbf help sign in
Idris-dev/CONTRIBUTING.md
169 lines 7.3 kB history raw
1# Contributing to Idris-Dev
3The Idris Community welcomes pull requests, bug reporting, and bug squashing!
4However, we cannot do it all ourselves, and want to make it as easy as possible to contribute changes to get things working.
5Here are a few guidelines that we would like contributors to follow so that we can have a chance of keeping on top of things.
7## Getting Started
91. Make sure you are familiar with [Git](http://git-scm.com/book).
101. Make sure you have a [GitHub account](https://github.com/signup/free).
111. Make sure you are familiar with: [Idris](http://eb.host.cs.st-andrews.ac.uk/writings/idris-tutorial.pdf).
121. Make sure you can install Idris:
13 * [Mac OS X](https://github.com/idris-lang/Idris-dev/wiki/Idris-on-OS-X-using-Homebrew)
14 * [Ubuntu](https://github.com/idris-lang/Idris-dev/wiki/Idris-on-Ubuntu)
15 * [Debian](https://github.com/idris-lang/Idris-dev/wiki/Idris-on-Debian)
16 * [Windows](https://github.com/idris-lang/Idris-dev/wiki/Idris-on-Windows)
18## Issue Reporting
20Before you report an issue, or wish to add cool functionality please try and check to see if there are existing [issues](https://github.com/idris-lang/Idris-dev/issues) and [pull requests](https://github.com/idris-lang/Idris-dev/pulls).
21We do not want you wasting your time, duplicating somebody's work!
23## The Campsite Rule
25We try to follow the **campsite rule**: leave the code base in better condition than you found it.
26Please clean up any messes that you find, and don't leave behind new messes for the next contributor.
28## Contributing to the default libraries.
30Idris ships with a set of packages in `libs/` that is provided as a default library.
32+ `prelude` is a collection of basic definitions, automatically imported by Idris programs.
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 that we want to test before possible inclusion in `base`.
35+ `effects` is a library which supports effectful programming.
37These 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 yet.
38These packages offer functionality that can be built on top of when constructing Idris programs.
40Everything in prelude will be imported automatically, unless given the `--noprelude` option.
41The contents of base are available with no special options, but modules must be imported.
42The 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.
44New contributions should be added to the contrib package (never directly to base or prelude!).
45If they turn out to be widely applicable and useful, they may later be moved into base.
47As Idris is still being developed we are open to suggestions and changes that make improvements to these default packages.
48Major changes to the library, or Idris itself, should be discussed first through the project's official channels of communication:
501. The mailing List.
511. On our IRC Channel `#idris` on freenode, or
521. As an RFC in the issue tracker
54Developers then seeking to add content to Idris's prelude and default library, should do so through a PR where more discussions and refinements can be made.
56We do not want you wasting your time nor duplicating somebody's work!
58## Making Changes
60Idris developers and hackers try to adhere to something similar to the [successful git branching model](http://nvie.com/posts/a-successful-git-branching-model/).
61The steps are described below.
63### New contributors
65For those new to the project:
671. Fork our [main development repository](https://github.com/idris-lang/Idris-dev) `idris-dev` on github e.g.
682. Clone your fork to your local machine:
70```
71$ git clone git@github.com/<your github user name>/Idris-dev.git
72```
743. Add `idris-lang/Idris-dev` as a remote upstream
76```
77$ git remote add upstream git@github.com:idris-lang/Idris-dev.git
78```
80### Existing Contributors
82For those already contributing to the project:
841. Ensure your existing clone is up-to-date with current `HEAD` e.g.
86```
87$ git fetch upstream
88$ git merge upstream/master
89```
91### Remaining Steps
93The remaining steps are the same for both new and existing contributors:
951. Create, and checkout onto, a topic branch on which to base you work.
96 * This is typically the master branch.
97 * Please avoid working on the `master` branch.
99```
100$ git branch fix/master/my_contrib master
101$ git checkout fix/master/my_contrib
102```
1041. Make commits of logical units.
1051. Check for unnecessary whitespace with
107```
108$ git diff --check
109```
1111. Make sure your commit messages are along the lines of:
113 Short (50 chars or less) summary of changes
115 More detailed explanatory text, if necessary. Wrap it to about 72
116 characters or so. In some contexts, the first line is treated as the
117 subject of an email and the rest of the text as the body. The blank
118 line separating the summary from the body is critical (unless you omit
119 the body entirely); tools like rebase can get confused if you run the
120 two together.
122 Further paragraphs come after blank lines.
124 - Bullet points are okay, too
126 - Typically a hyphen or asterisk is used for the bullet, preceded by a
127 single space, with blank lines in between, but conventions vary here
1291. Make sure you have added any necessary tests for your changes.
1301. Run all the tests to ensure nothing else was accidentally broken.
132```
133$ make test
134```
1361. Push your changes to a topic branch in your fork of the repository.
138```
139$ git push origin fix/master/my_contrib
140```
1421. Go to GitHub and submit a pull request to `idris-dev`
144From there you will have to wait on one of the `idris-dev` committers to respond to the request.
145This response might be an accept or some changes/improvements/alternatives will be suggest.
146We do not guarantee that all requests will be accepted.
148## Increasing chances of acceptance.
150To help increase the chance of your pull request being accepted:
1521. Run the tests.
1531. Update the documentation, the surrounding code, examples elsewhere, guides, whatever is affected by your contribution
1541. Use appropriate code formatting for both Idris and Haskell.
156## Additional Resources
158* [Idris Wiki](https://github.com/idris-lang/Idris-dev/wiki);
159* [Zen Of Idris](https://github.com/idris-lang/Idris-dev/wiki/The-Zen-of-Idris);
160* Idris FAQs: [Official](https://idris.readthedocs.io/en/latest/faq/faq.html); [Unofficial](https://github.com/idris-lang/Idris-dev/wiki/Unofficial-FAQ);
161* [Idris Manual](https://github.com/idris-lang/Idris-dev/wiki/Manual);
162* [Idris Tutorial](https://idris.readthedocs.io/en/latest/tutorial/index.html);
163* [Idris News](http://www.idris-lang.org/news/);
164* [other Idris docs](http://www.idris-lang.org/documentation/).
165* [Using Pull Requests](https://help.github.com/articles/using-pull-requests)
166* [General GitHub Documentation](https://help.github.com/).
169Adapted from the most excellent contributing files from the [Puppet project](https://github.com/puppetlabs/puppet) and [Factory Girl Rails](https://github.com/thoughtbot/factory_girl_rails/blob/master/CONTRIBUTING.md)