Skip to content

Latest commit

 

History

History
184 lines (127 loc) · 7.8 KB

CONTRIBUTING.md

File metadata and controls

184 lines (127 loc) · 7.8 KB
Raw

Contributing to Idris-Dev

The Idris Community welcomes pull requests, bug reporting, and bug squashing! However, we cannot do it all ourselves, 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.
  2. Make sure you have a GitHub account.
  3. Make sure you are familiar with: Idris.
  4. Make sure you can install Idris:

Issue Reporting

Before you report an issue, or wish to add cool functionality please try and check to see if there are existing issues and pull requests. We do not want you wasting your time, duplicating somebody's work!

Template

Try as closely as possible to describe the issue, ensuring that it has sections that match the following headings:

# Steps to Reproduce

# Expected Behavior

# Observed Behavior

In addition, please attach complete source files that exhibit the issue to quoting from them in the issue.

Feature Requests

We would be delighted to receive feature requests only if they are feasible to implement and the author is willing to implement the suggested features themself. The current Idris developer team consists mostly of volunteers, and so it is unfortunately hard to accommodate implementing nice-to-have ideas that are not essential for core language development.

The Campsite Rule

We try to follow the campsite rule: leave the code base in better condition than you found it. Please clean up any messes that you find, and don't leave behind new messes for the next contributor.

Contributing to the default libraries.

Idris ships with a set of packages in libs/ that is provided as a default library.

  • prelude is a collection of basic definitions, automatically imported by Idris programs.
  • base is tried and tested code that may be useful, and has seen active use in multiple projects.
  • contrib is code that is experimental in design and that we want to test before possible inclusion in base.
  • effects is a library which supports effectful programming.

These 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. These packages offer functionality that can be built on top of when constructing Idris programs.

Everything in prelude will be imported automatically, unless given the --noprelude option. The contents of base are available with no special options, but modules must be imported. 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.

New contributions should be added to the contrib package (never directly to base or prelude!). If they turn out to be widely applicable and useful, they may later be moved into base.

As Idris is still being developed we are open to suggestions and changes that make improvements to these default packages. Major changes to the library, or Idris itself, should be discussed first through the project's official channels of communication:

  1. The mailing List.
  2. On our IRC Channel #idris on freenode, or
  3. As an RFC in the issue tracker

Developers 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.

We do not want you wasting your time nor duplicating somebody's work!

Making Changes

Idris developers and hackers try to adhere to something similar to the successful git branching model. The steps are described below.

New contributors

For those new to the project:

  1. Fork our main development repository idris-dev on github e.g.
  2. Clone your fork to your local machine:
$ git clone [email protected]:<your github user name>/Idris-dev.git
  1. Add idris-lang/Idris-dev as a remote upstream
$ git remote add upstream [email protected]:idris-lang/Idris-dev.git

Existing Contributors

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

Remaining Steps

The remaining steps are the same for both new and existing contributors:

  1. Create, and checkout onto, a topic branch on which to base you work.
  • This is typically the master branch.
  • 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.
  2. 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

  2. Make sure you have added any necessary tests for your changes.

  3. Run all the tests to ensure 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.

Increasing chances of acceptance.

To help increase the chance of your pull request being accepted:

  1. Run the tests.
  2. Update the documentation, the surrounding code, examples elsewhere, guides, whatever is affected by your contribution
  3. Use appropriate code formatting for both Idris and Haskell.

Additional Resources

Adapted from the most excellent contributing files from the Puppet project and Factory Girl Rails