Contributing guidelines

Any contribution is appreciated! You might want to:

How can I contribute?

Use issues to report bugs and features
- If you report a bug in the results for a particular pdf, include that pdf. This allows others to replicate the issue.
Fix issues by creating pull requests.
Help others by giving your thoughts on open issues and pull requests.

Search previous issues, as yours might be a duplicate.
When creating a new issue for a bug, include a minimal reproducible example.
When creating a new issue for a feature, be sure to describe the context of the problem you are trying to solve. This will help others to see the importance of your feature request.

A pull request should close an existing issue.
Pull requests should be merged to develop, not master. This ensures that master always equals the released version.
Include unit tests when possible. In case of bugs, this will help to prevent the same mistake in the future. In case of features, this will show that your code works correctly.
Code should work for Python 2.7 and Python 3.x (for now), conform to PEP8 code style (with a line-width of 120) and properly documented with docstrings.
Check spelling and grammar.
Don't forget to update the CHANGELOG.md

Clone the repository

git clone https://github.com/pdfminer/pdfminer.six
cd pdfminer.six