Skip to content

Latest commit

 

History

History
141 lines (95 loc) · 5.44 KB

CONTRIBUTING.md

File metadata and controls

141 lines (95 loc) · 5.44 KB
Raw

Contributing to Idris-Crypto

Idris Hackers and those working specifically on idris-crypto 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.
  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!

The Campsite Rule

A basic rule when contributing to Idris is the campsite rule: leave the codebase 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.

Making Changes

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

New contributors

For those new to the project:

  1. Fork our main development repository idris-crypto on github e.g.
  2. Clone your fork to your local machine:
$ git clone git@github.com/<your github user name>/idris-crypto.git
  1. Add idris-hackers/idris-crypto as a remote upstream
$ git remote add upstream git@github.com:idris-hackers/idrus-crypto.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.
  • 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.
  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 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-crypto

From there you will have to wait on one of the idris-crypto 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.
  2. Update the documentation, the surrounding one, 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 Factroy Girl Rails