♥ [Beaver](https://github.com/josegonzalez/python-beaver) 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.

The [issue tracker](https://github.com/josegonzalez/python-beaver/issues) is

the preferred channel for [bug reports](#bugs), [features requests](#features)

and [submitting pull requests](#pull-requests).

<a name="bugs"></a>

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** &mdash; check if the issue has already been

reported.

2. **Check if the issue has been fixed** &mdash; try to reproduce it using the

latest `master` branch in the repository.

3. **Reproduce the problem** &mdash; providing as much detail as possible so the

bug can be identified and replicated locally.

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 OS and Beaver

versions were running when you experienced the outcome? What would you expect to

be the outcome? All these details will help people to fix any potential bugs.

Example:

<a name="features"></a>

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.

<a name="pull-requests"></a>

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

Adhering to the following process is the best way to get your work

included in the project:

1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your

fork, and configure the remotes:

```bash

# Clone your fork of the repo into the current directory

git clone https://github.com/<your-username>/python-beaver.git

# Navigate to the newly cloned directory

cd python-beaver

# Assign the original repo to a remote called "upstream"

git remote add upstream https://github.com/josegonzalez/python-beaver.git

```

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

```bash

git checkout master

git pull upstream master

```

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/about-git-rebase/)

feature to tidy up your commits before making them public.

- Test cases should accompany any change in functionality to the code-base

- Any change to end-user functionality should include corrosponding documentation

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

```bash

git pull [--rebase] upstream master

```

6. Run the test suite locally, ensuring they pass:

```bash

nosetests #./install-dependencies.sh to install the pre-requirements

```

7. Push your topic branch up to your fork:

```bash

git push origin <topic-branch-name>

```

8. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)

with a clear title and description.

**IMPORTANT**: By submitting a patch, you agree to allow the project

owners to license your work under the terms of the [License](LICENSE.txt).