mabrasil/generator-ocaml

# Contributing to <%= pkgCapitalizedName %>

♥ <%= pkgCapitalizedName %> and want to get involved?

Thanks! There are plenty of ways you can help! Please take a moment to review
this document in order to make the contribution process easy and effective for
everyone involved.

Following these guidelines helps to communicate that you respect the time of
the developers managing and developing this open source project. In return,
they should reciprocate that respect in addressing your issue or assessing
patches and features.

## Table of Contents

- [Versioning](#versioning)
- [Using the Issue Tracker](#using-the-issue-tracker)
- [Bug Reports](#bug-reports)
- [Feature Requests](#feature-requests)
- [Pull Requests](#pull-requests)

## Versioning

It is intended to maintain this project under the [Semantic Versioning] (http://semver.org/) guidelines. Releases will
be numbered with the following format:

`<major>.<minor>.<patch>`

## Using the Issue Tracker

The issue tracker is the preferred channel for [bug reports](#bug-reports),
[features requests](#feature-requests) and [submitting pull
requests](#pull-requests), but please respect the following restrictions:

- Please **do not** use the issue tracker for personal support requests (use
  [Stack Overflow](http://stackoverflow.com) or IRC).

- Please **do not** derail or troll issues. Keep the discussion on topic and
  respect the opinions of others.

## Bug Reports

A bug is a **demonstrable problem** that is caused by the code in the repository.
Good bug reports are extremely helpful - thank you!

*Guidelines for bug reports*:

1. **Use the GitHub issue search** to check if the issue has already been
   reported.

1. **Check if the issue has been fixed**; try to reproduce it using the
   latest `master` or development branch in the repository.

3. **Isolate the problem** and create a reduced *test
   case*.

A good bug report shouldn't leave others needing to chase you up for more
information. Please try to be as detailed as possible in your report.

> - What is your environment?
  - What steps will reproduce the issue?
  - What would you expect to be the outcome?

  All these details will help people to fix any potential bugs.

Example:

> Short and descriptive example bug report title
>
> A summary of the issue and the environment in which it occurs. If
> suitable, include the steps required to reproduce the bug.
>
> 1. This is the first step
> 1. This is the second step
> 1. Further steps, etc.
>
> Any other information you want to share that is relevant to the issue being
> reported. This might include the lines of code that you have identified as
> causing the bug, and potential solutions (and your opinions on their
> merits).

## Feature Requests

Feature requests are welcome. But take a moment to find out whether your idea
fits with the scope and aims of the project. It's up to *you* to make a strong
case to convince the project's developers of the merits of this feature. Please
provide as much detail and context as possible.

## Pull Requests

Good pull requests - patches, improvements, new features - are a fantastic
help. They should remain focused in scope and avoid containing unrelated
commits.

**Please ask first** before embarking on any significant pull request (e.g.
implementing features, refactoring code, porting to a different language),
otherwise you risk spending a lot of time working on something that the
project's developers might not want to merge into the project.

Please adhere to the coding conventions used throughout a project (indentation,
accurate comments, etc.) and any other requirements (such as test coverage).

Follow this process if you'd like your work considered for inclusion in the
project:

1. [Fork](http://help.github.com/fork-a-repo/) the project [here](https://github.com/<%= pkgSlugName %>/<%= userName %>#fork-destination-box), clone your fork, and configure the remotes:

   ```bash
   # Clone your fork of the repo into the current directory
   git clone https://github.com/<%= userName %>/<%= pkgSlugName %>
   # Navigate to the newly cloned directory
   cd <%= pkgSlugName %>
   # Assign the original repo to a remote called "upstream"
   git remote add upstream https://github.com/<%= userName %>/<%= pkgSlugName %>
   ```

2. If you cloned a while ago, get the latest changes from upstream:

   ```bash
   git checkout <dev-branch>
   git pull upstream <dev-branch>
   ```

3. Create a new topic branch (off the main project development branch) to
   contain your feature, change, or fix:

   ```bash
   git checkout -b <topic-branch-name>
   ```

4. Commit your changes in logical chunks. Please adhere to these [git commit
   message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
   or your code is unlikely be merged into the main project. Use Git's
   [interactive rebase](https://help.github.com/articles/interactive-rebase)
   feature to tidy up your commits before making them public.

5. Locally merge (or rebase) the upstream development branch into your topic branch:

   ```bash
   git pull [--rebase] upstream <dev-branch>
   ```

6. Push your topic branch up to your fork:

   ```bash
   git push origin <topic-branch-name>
   ```

7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
   [here](https://github.com/<%= userName %>/<%= pkgSlugName %>/compare) with a
   clear title and description.