From 19c078f0d0d174b2980e806541c4665be7b000e2 Mon Sep 17 00:00:00 2001
From: Pieter Marsman <pietermarsman@gmail.com>
Date: Sun, 20 Oct 2019 14:18:26 +0200
Subject: [PATCH] Update CONTRIBUTING.md

---
 CONTRIBUTING.md | 55 +++++++++++++++++++++++++++++++------------------
 1 file changed, 35 insertions(+), 20 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5b6676c..8accc02 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -13,37 +13,52 @@ Any contribution is appreciated! You might want to:
 * Use [issues](https://github.com/pdfminer/pdfminer.six/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](https://help.github.com/en/articles/creating-a-pull-request)
-* Help others giving your thoughts on open issues and pull requests.
+* Fix issues by [creating pull requests](https://help.github.com/en/articles/creating-a-pull-request).
+* Help others by giving your thoughts on open issues and pull requests.
 
-## General guidelines for creating issues and pull requests
+## Guidelines for creating issues
 
 * 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. 
-* Link pull request to a single issue.
-* Pull requests should be merged to develop, not master. This ensures that master always equals the released verion.  
+
+## Guideline for creating pull 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).
-* Code changes should conform to PEP8 coding style (with a line-width of 120). Existing code may stay as it is. 
-* New features should be well documented using docstrings.
+* 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](CHANGELOG.md#[Unreleased])
 
-## Dev setup
+## Getting started
 
-```sh
-# Clone the repo
-git clone https://github.com/pdfminer/pdfminer.six
-cd pdfminer.six
+1. Clone the repository
 
-# Install dev dependencies
-pip install -e .[dev]
+    ```sh
+    git clone https://github.com/pdfminer/pdfminer.six
+    cd pdfminer.six
+    ```
 
-# Run tests on all Python versions
-tox
+2. Install dev dependencies
 
-# Run tests on a single version
-tox -e py36
-```
+    ```sh
+    pip install -e .[dev]
+    ```
+
+3. Run the tests
+
+    On all Python versions:
+
+    ```sh
+    tox
+   ```
+   
+   Or on a single Python version:
+   
+   ```sh
+    tox -e py36
+    ```