Add pre-commit scripts and HOWTORELEASE docs

Author: nicoddemus

.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+exclude: '^($|.*\.bin)'
+repos:
+  - repo: https://github.com/ambv/black
+    rev: 18.6b4
+    hooks:
+      - id: black
+        args: [--safe, --quiet]
+        language_version: python3.6
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v1.3.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+  - repo: local
+    hooks:
+      - id: rst
+        name: rst
+        entry: rst-lint --encoding utf-8
+        files: ^(CHANGELOG.rst|README.rst|HOWTORELEASE.rst|changelog/.*)$
+        language: python
+        additional_dependencies: [pygments, restructuredtext_lint]
+        python_version: python3.6

HOWTORELEASE.rst

@@ -0,0 +1,7 @@
+Here are the steps on how to make a new release.
+
+1. Create a ``release-VERSION`` branch from ``upstream/master``.
+2. Update ``CHANGELOG.rst``.
+3. Push a branch with the changes.
+4. Once all builds pass, push a tag to ``upstream``.
+5. Merge the PR.

README.rst

@@ -322,6 +322,26 @@ temporarily:
         return my_cm
 
 
+Contributing
+============
+
+Contributions are welcome! After cloning the repository, create a virtual env
+and install ``pytest-mock`` in editable mode with ``dev`` extras:
+
+.. code-block:: console
+
+    $ pip install --editable .[dev]
+    $ pre-commit install
+
+Tests are run with ``tox``, you can run the baseline environments before submitting a PR:
+
+.. code-block:: console
+
+    $ tox -e py27,py36,linting
+
+Style checks and formatting are done automatically during commit courtesy of
+`pre-commit <https://pre-commit.com>`_.
+
 License
 =======
 

setup.py

@@ -1,7 +1,7 @@
-from setuptools import setup
-
 from io import open
 
+from setuptools import setup
+
 setup(
     name='pytest-mock',
     entry_points={
@@ -23,6 +23,12 @@
     description='Thin-wrapper around the mock package for easier use with py.test',
     long_description=open('README.rst', encoding='utf-8').read(),
     keywords="pytest mock",
+    extras_require={
+        "dev": [
+            "pre-commit",
+            "tox",
+        ]
+    },
     classifiers=[
         'Development Status :: 5 - Production/Stable',
         'Framework :: Pytest',