<commit_before># How to contribute

Dokku loves to welcome your contributions. There are several ways to help out:

* Create an [issue](https://github.com/progrium/dokku/issues) on GitHub, if you
  have found a bug
* Write test cases for open bug issues
* Write patches for open bug/feature issues, preferably with test cases
  included
* Contribute to the [documentation](http://progrium.viewdocs.io/dokku/)

There are a few guidelines that we need contributors to follow so that we have
a chance of keeping on top of things.

## Topics

* [Reporting Security Issues](#reporting-security-issues)
* [Reporting Issues](#reporting-other-issues)
* [Contributing](#contributing)
  * [Making Changes](#making-changes)
  * [Which branch to base the work](#which-branch-to-base-the-work)
  * [Submitting Changes](#submitting-changes)
  * [When will my change be merged?](#when-will-my-change-be-merged)
  * [Test cases and codesniffs](#test-cases-and-codesniffs)
* [Additional Resources](#additional-resources)

## Reporting security issues

The Dokku maintainers take security seriously. If you discover a security
issue, please bring it to their attention right away!

Please **DO NOT** file a public issue, instead send your report privately to
[<EMAIL>](mailto:<EMAIL>),

Security reports are greatly appreciated and we will publicly thank you for it.

## Reporting other issues

A great way to contribute to the project is to send a detailed report when you
encounter an issue. We always appreciate a well-written, thorough bug report,
and will thank you for it!

Sometimes dokku is missing a feature you need. In some cases, those features can
be found in pre-existing [plugins](http://progrium.viewdocs.io/dokku/plugins/),
and we encourage our users to create and contribute such packages. From time to
time, we will also pull plugins into the dokku core when the task they solve is
a common one for our users.

Check that [our issue database](https://github.com/progrium/dokku/issues)
doesn't already include that problem or suggestion before submitting an issue.
If you find a match, add a quick "+1" or "I have this problem too." Doing this
helps prioritize the most common problems and requests.

When reporting issues, please include your host OS (Ubuntu 14.04, Fedora 19,
etc). Please include:

* The output of `uname -a`.
* The output of `docker version`.
* The output of `docker -D info`.
* The output of `dokku version`.
* The output of `dokku plugin`.
* The output of `free -m`

Please also include the steps required to reproduce the problem if possible and
applicable. This information will help us review and fix your issue faster.

**Issue Report Template**:

```
Description of problem:


Output of the following commands

- `uname -a`:
- `docker version`:
- `docker -D info`:
- `dokku version`:
- `dokku plugin`:
- `docker inspect CONTAINER_ID` (if applicable):
- `cat /home/dokku/<app>/nginx.conf` (if applicable):
- Output of failing dokku commands with `dokku trace on` 
  (BEWARE: `trace on` will print environment variables for some commands, be sure you're not exposing any sensitive information when posting issues):

Environment details (AWS, VirtualBox, physical, etc.):<commit_msg>Add herokuish version to desired debugging info<commit_after># How to contribute

Dokku loves to welcome your contributions. There are several ways to help out:

* Create an [issue](https://github.com/progrium/dokku/issues) on GitHub, if you
  have found a bug
* Write test cases for open bug issues
* Write patches for open bug/feature issues, preferably with test cases
  included
* Contribute to the [documentation](http://progrium.viewdocs.io/dokku/)

There are a few guidelines that we need contributors to follow so that we have
a chance of keeping on top of things.

## Topics

* [Reporting Security Issues](#reporting-security-issues)
* [Reporting Issues](#reporting-other-issues)
* [Contributing](#contributing)
  * [Making Changes](#making-changes)
  * [Which branch to base the work](#which-branch-to-base-the-work)
  * [Submitting Changes](#submitting-changes)
  * [When will my change be merged?](#when-will-my-change-be-merged)
  * [Test cases and codesniffs](#test-cases-and-codesniffs)
* [Additional Resources](#additional-resources)

## Reporting security issues

The Dokku maintainers take security seriously. If you discover a security
issue, please bring it to their attention right away!

Please **DO NOT** file a public issue, instead send your report privately to
[<EMAIL>](mailto:<EMAIL>),

Security reports are greatly appreciated and we will publicly thank you for it.

## Reporting other issues

A great way to contribute to the project is to send a detailed report when you
encounter an issue. We always appreciate a well-written, thorough bug report,
and will thank you for it!

Sometimes dokku is missing a feature you need. In some cases, those features can
be found in pre-existing [plugins](http://progrium.viewdocs.io/dokku/plugins/),
and we encourage our users to create and contribute such packages. From time to
time, we will also pull plugins into the dokku core when the task they solve is
a common one for our users.

Check that [our issue database](https://github.com/progrium/dokku/issues)
doesn't already include that problem or suggestion before submitting an issue.
If you find a match, add a quick "+1" or "I have this problem too." Doing this
helps prioritize the most common problems and requests.

When reporting issues, please include your host OS (Ubuntu 14.04, Fedora 19,
etc). Please include:

* The output of `uname -a`.
* The output of `free -m`
* The output of `docker version`.
* The output of `docker -D info`.
* The output of `docker run -ti gliderlabs/herokuish:latest herokuish version`
* The output of `dokku version`.
* The output of `dokku plugin`.

Please also include the steps required to reproduce the problem if possible and
applicable. This information will help us review and fix your issue faster.

**Issue Report Template**:

```
Description of problem:


Output of the following commands

- `uname -a`:
- `free -m`:
- `docker version`:
- `docker -D info`:
- `docker run -ti gliderlabs/herokuish:latest herokuish version`:
- `dokku version`:
- `dokku plugin`:
- `docker inspect CONTAINER_ID` (if applicable):
- `cat /home/dokku/<app>/nginx.conf` (if applicable):
- Output of failing dokku commands with `dokku trace on` 
  (BEWARE: `trace on` will print environment variables for some commands, be sure you're not exposing any sensitive information when posting issues):

Environment details (AWS, VirtualBox, physical, etc.):
{'fraction_non_alphanumeric': 0.08900999091734786, 'fraction_numerical': 0.002119285498032092, 'mean_word_length': 4.552100840336134, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7008057', 'n_tokens_mistral': 1922, 'n_tokens_neox': 1802, 'n_words': 866}