Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/JulienPalard/textunwrap/issues.

If you are reporting a bug, please include detailed steps to reproduce the bug, if possible the file used, or better a minimum sample file reproducing the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Enhance the algorithm¶

The current unwrapping algorithm is pretty dumb, any pull requests to enhance it are welcome.

Get Started!¶

Ready to contribute? Here’s how to set up textunwrap for local development.

Fork the textunwrap repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/textunwrap.git

Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ flake8 textunwrap tests
$ pytest
```

Commit your changes and push your branch to GitHub:

$ git add -p
$ git commit -m "Your detailed description of your changes."
$ git push -u origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/JulienPalard/textunwrap/pull_requests and make sure that the tests pass for all supported Python versions.