idris-lang/Idris-dev
1
1
Fork 0
mirror of https://github.com/idris-lang/Idris-dev.git synced 2024-10-04 09:58:27 +03:00
Code Issues Projects Releases Wiki Activity

Added contributing guidelines.

Browse Source
This commit is contained in:
Jan de Muijnck-Hughes 2013-12-10 17:11:21 +00:00
parent 2f52264335
commit e8ab848144
1 changed files with 112 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,112 @@
# Contributing to Idris-Dev
The Idris Community welcomes pull requests, bug reporting, and bug squashing!
However, we cannot do it all ourself, and want to make it as easy as possible to contribute changes to get things working.
Here are a few guidelines that we would like contributors to follow so that we can have a chance of keeping on top of things.
## Getting Started
1. Make sure you are familiar with [Git](http://git-scm.com/book).
1. Make sure you have a [GitHub account](https://github.com/signup/free).
1. Make sure you are familiar with: [Idris](http://eb.host.cs.st-andrews.ac.uk/writings/idris-tutorial.pdf).
1. Make sure you can install `Idris`:
* [Mac OS X](https://github.com/idris-lang/Idris-dev/wiki/Idris-on-OS-X-using-Homebrew)
* [Ubuntu](https://github.com/idris-lang/Idris-dev/wiki/Idris-on-Ubuntu)
* [Debian](https://github.com/idris-lang/Idris-dev/wiki/Idris-on-Debian)
* [Windows](https://github.com/idris-lang/Idris-dev/wiki/Idris-on-Windows)
# Issue Reporting
Before 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).
We do not want you wasting your time, duplicating somebody's work!
## Making Changes
Idris developers and hackers try to adhere to something similar to the [successful git branching model](http://nvie.com/posts/a-successful-git-branching-model/).
The steps are straightforward.
For those new to the project:
1. Fork the `idris-dev` repo e.g.
$ git clone git@github.com/<your github user name>/Idris-dev.git
$ git remote add upstream git@github.com:idris-lang/Idris-dev.git
For those already contributing to the project:
1. Ensure your existing clone is up-to-date with current HEAD e.g.
$ git fetch upstream
$ git merge upstream/master
The remaining steps are the same:
1. Create, and checkout onto, a topic branch on which to base you work.
* This is typically the master branch.
* For your own sanity, please avoid working on the `master` branch.
$ git branch fix/master/my_contrib master
$ git checkout fix/master/my_contrib
1. Make commits of logical units.
1. Check for unnecessary whitespace with
$ git diff --check
1. Make sure your commit messages are along the lines of:
Short (50 chars or less) summary of changes
More detailed explanatory text, if necessary. Wrap it to about 72
characters or so. In some contexts, the first line is treated as the
subject of an email and the rest of the text as the body. The blank
line separating the summary from the body is critical (unless you omit
the body entirely); tools like rebase can get confused if you run the
two together.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- Typically a hyphen or asterisk is used for the bullet, preceded by a
single space, with blank lines in between, but conventions vary here
1. Make sure you have added any necessary tests for your changes.
1. Run all the tests to assure nothing else was accidentally broken.
$ make test
1. Push your changes to a topic branch in your fork of the repository.
$ git push origin fix/master/my_contrib
1. Go to GitHub and submit a pull request to `idris-dev`
From there you will have to wait on one of the `idris-dev` committers to respond to the request.
This response might be an accept or some changes/improvements/alternatives will be suggest.
We do not guarantee that all requests will be accepted.
## Increases chances of acceptance.
To help increase the chance of your pull request being accepted:
1. Run the tests.
1. Update the documentation, the surrounding one, examples elsewhere, guides, whatever is affected by your contribution
1. Use appropriate code formatting for both `Idris` and `Haskell`.
## Additional Resources
* [Idris Wiki](https://github.com/idris-lang/Idris-dev/wiki);
* [Zen Of Idris](https://github.com/idris-lang/Idris-dev/wiki/The-Zen-of-Idris);
* Idris FAQs: [Official](http://www.idris-lang.org/documentation/faq/); [Unofficial](https://github.com/idris-lang/Idris-dev/wiki/Unofficial-FAQ);
* [Idris Manual](https://github.com/idris-lang/Idris-dev/wiki/Manual);
* [Idris Tutorial](http://eb.host.cs.st-andrews.ac.uk/writings/idris-tutorial.pdf);
* [Idris News](http://www.idris-lang.org/news/);
* [other Idris docs](http://www.idris-lang.org/documentation/).
* [Using Pull Requests](https://help.github.com/articles/using-pull-requests)
* [General GitHub Documentation](https://help.github.com/).
Adapted 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)