From c149f860b5a1372d95cd558315c5c0f8b8d30180 Mon Sep 17 00:00:00 2001
From: "James R. Barlow" <jim@purplerock.ca>
Date: Fri, 20 Sep 2019 17:02:22 -0700
Subject: [PATCH] Add contributing guide

---
 docs/contributing.rst | 38 ++++++++++++++++++++++++++++++++++++++
 docs/index.rst        |  7 ++++++-
 2 files changed, 44 insertions(+), 1 deletion(-)
 create mode 100644 docs/contributing.rst

diff --git a/docs/contributing.rst b/docs/contributing.rst
new file mode 100644
index 00000000..2a7c81ff
--- /dev/null
+++ b/docs/contributing.rst
@@ -0,0 +1,38 @@
+=======================
+Contributing guidelines
+=======================
+
+Contributions are welcome!
+
+Big changes
+===========
+
+Please open a new issue to discuss or propose a major change. Not only is it fun
+to discuss big ideas, but we might save each other's time too. Perhaps some of the
+work you're contemplating is already half-done in a development branch.
+
+Code style
+==========
+
+We use PEP8, ``black`` for code formatting and ``isort`` for import sorting. The
+settings for programs are in ``pyproject.toml`` and ``setup.cfg``.
+
+Tests
+=====
+
+New features should come with tests that confirm their correctness.
+
+New Python dependencies
+=======================
+
+If you are proposing a change that will require a new Python dependency, we
+prefer dependencies that are already packaged by Debian or Red Hat. This makes
+life much easier for our downstream package maintainers.
+
+Python dependencies must also be GPLv3 compatible.
+
+New non-Python dependencies
+===========================
+
+OCRmyPDF uses several external programs (Tesseract, Ghostscript and others) for
+its functionality. In general we prefer to avoid adding new external programs.
diff --git a/docs/index.rst b/docs/index.rst
index 29136779..b050c6da 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -22,11 +22,16 @@ PDF is the best format for storing and exchanging scanned documents.  Unfortunat
    cookbook
    docker
    advanced
-   api
    batch
    security
    errors
 
+.. toctree::
+   :caption: Developers
+   :maxdepth: 2
+
+   api
+   contributing
 
 Indices and tables
 ==================