git.iko.soy/Idris-dev
on 7afa310 help sign in
Idris-dev/CONTRIBUTING.md
141 lines 5.5 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 ourself, 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
25A basic rule when contributing to Idris is the **campsite rule**: leave the codebase 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## Making Changes
30Idris developers and hackers try to adhere to something similar to the [successful git branching model](http://nvie.com/posts/a-successful-git-branching-model/).
31The steps are straightforward.
33### New contributors
35For those new to the project:
371. Fork our [main development repository](https://github.com/idris-lang/Idris-dev) `idris-dev` on github e.g.
382. Clone your fork to your local machine:
40```
41$ git clone git@github.com/<your github user name>/Idris-dev.git
42```
443. Add `idris-lang/Idris-dev` as a remote upstream
46```
47$ git remote add upstream git@github.com:idris-lang/Idris-dev.git
48```
50### Existing Contributors
52For those already contributing to the project:
541. Ensure your existing clone is up-to-date with current `HEAD` e.g.
56```
57$ git fetch upstream
58$ git merge upstream/master
59```
61### Remaining Steps
63The remaining steps are the same for both new and existing contributors:
651. Create, and checkout onto, a topic branch on which to base you work.
66 * This is typically the master branch.
67 * For your own sanity, please avoid working on the `master` branch.
69```
70$ git branch fix/master/my_contrib master
71$ git checkout fix/master/my_contrib
72```
741. Make commits of logical units.
751. Check for unnecessary whitespace with
77```
78$ git diff --check
79```
811. Make sure your commit messages are along the lines of:
83 Short (50 chars or less) summary of changes
85 More detailed explanatory text, if necessary. Wrap it to about 72
86 characters or so. In some contexts, the first line is treated as the
87 subject of an email and the rest of the text as the body. The blank
88 line separating the summary from the body is critical (unless you omit
89 the body entirely); tools like rebase can get confused if you run the
90 two together.
92 Further paragraphs come after blank lines.
94 - Bullet points are okay, too
96 - Typically a hyphen or asterisk is used for the bullet, preceded by a
97 single space, with blank lines in between, but conventions vary here
991. Make sure you have added any necessary tests for your changes.
1001. Run all the tests to assure nothing else was accidentally broken.
102```
103$ make test
104```
1061. Push your changes to a topic branch in your fork of the repository.
108```
109$ git push origin fix/master/my_contrib
110```
1121. Go to GitHub and submit a pull request to `idris-dev`
114From there you will have to wait on one of the `idris-dev` committers to respond to the request.
115This response might be an accept or some changes/improvements/alternatives will be suggest.
116We do not guarantee that all requests will be accepted.
118## Increases chances of acceptance.
120To help increase the chance of your pull request being accepted:
1221. Run the tests.
1231. Update the documentation, the surrounding one, examples elsewhere, guides, whatever is affected by your contribution
1241. Use appropriate code formatting for both `Idris` and `Haskell`.
126## Additional Resources
128* [Idris Wiki](https://github.com/idris-lang/Idris-dev/wiki);
129* [Zen Of Idris](https://github.com/idris-lang/Idris-dev/wiki/The-Zen-of-Idris);
130* Idris FAQs: [Official](http://www.idris-lang.org/documentation/faq/); [Unofficial](https://github.com/idris-lang/Idris-dev/wiki/Unofficial-FAQ);
131* [Idris Manual](https://github.com/idris-lang/Idris-dev/wiki/Manual);
132* [Idris Tutorial](http://eb.host.cs.st-andrews.ac.uk/writings/idris-tutorial.pdf);
133* [Idris News](http://www.idris-lang.org/news/);
134* [other Idris docs](http://www.idris-lang.org/documentation/).
135* [Using Pull Requests](https://help.github.com/articles/using-pull-requests)
136* [General GitHub Documentation](https://help.github.com/).
139Adapted from the most excellent contributing files from the [Puppet project](https://github.com/puppetlabs/puppet) and [Factroy Girl Rails](https://github.com/thoughtbot/factory_girl_rails/blob/master/CONTRIBUTING.md)