From 8b96b7f844b773a906fa5a9b25f8bb807b045b3a Mon Sep 17 00:00:00 2001
From: Brian Grohe <grohe43@gmail.com>
Date: Thu, 31 Oct 2019 23:26:57 -0400
Subject: [PATCH] Add basic contrib document

These commands still need to be verified
---
 CONTRIBUTING.rst | 141 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 141 insertions(+)
 create mode 100644 CONTRIBUTING.rst

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
new file mode 100644
index 0000000..ba6c996
--- /dev/null
+++ b/CONTRIBUTING.rst
@@ -0,0 +1,141 @@
+Contributing Guidelines
+=======================
+
+So you're interested in contributing to Flask-apispec  <https://github.com/jmcarp/flask-apispec>`__?
+That's awesome! We welcome contributions from anyone willing to work in good faith with
+other contributors and the community.
+
+Questions, Feature Requests, Bug Reports, and Feedback…
+-------------------------------------------------------
+
+…should all be reported on the `Github Issue Tracker`_ .
+
+.. _`Github Issue Tracker`: https://github.com/jmcarp/flask-apispec/issues?state=open
+
+Ways to Contribute
+------------------
+
+- Comment on some of flask-apispec's `open issues <https://github.com/jmcarp/flask-apispec/issues?state=open>`_ 
+- Improve `the docs <https://flask-apispec.readthedocs.io/>`_.
+  For straightforward edits,
+  click the ReadTheDocs menu button in the bottom-right corner of the page and click "Edit".
+  See the :ref:`Documentation <contributing_documentation>` section of this page if you want to build the docs locally.
+- If you think you've found a bug, `open an issue <https://github.com/jmcarp/flask-apispec/issues?state=open>`_.
+- Contribute an :ref:`example usage <contributing_examples>` of flask-apispec.
+- Send a PR for an open issue (especially one `labeled "help wanted" <https://github.com/jmcarp/flask-apispec/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22>`_). The next section details how to contribute code.
+
+
+Contributing Code
+-----------------
+
+In General
+++++++++++
+
+- `PEP 8`_, when sensible.
+- Test ruthlessly. Write docs for new features.
+- Even more important than Test-Driven Development--*Human-Driven Development*.
+
+.. _`PEP 8`: https://www.python.org/dev/peps/pep-0008/
+
+In Particular
++++++++++++++
+
+
+Setting Up for Local Development
+********************************
+
+1. Fork flask-apispec_ on Github.
+
+::
+
+    $ git clone https://github.com/jmcarp/flask-apispec.git
+    $ cd flask-apispec
+
+2. Install development requirements. **It is highly recommended that you use a virtualenv.**
+   Use the following command to install an editable version of
+   flask-apispec along with its development requirements.
+
+::
+
+    # After activating your virtualenv
+    $ pip install -e '.[dev]'
+
+3. Install the pre-commit hooks, which will format and lint your git staged files.
+
+::
+
+    # The pre-commit CLI was installed above
+    $ pre-commit install --allow-missing-config
+
+Git Branch Structure
+********************
+
+Flask-apispec abides by the following branching model:
+
+``master``
+    Current development branch. **New features should branch off here**.
+
+**Always make a new branch for your work**, no matter how small. Also, **do not put unrelated changes in the same branch or pull request**. This makes it more difficult to merge your changes.
+
+Pull Requests
+**************
+
+1. Create a new local branch.
+
+::
+
+    # For a new feature
+    $ git checkout -b name-of-feature master
+
+
+2. Commit your changes. Write `good commit messages <https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html>`_.
+
+::
+
+    $ git commit -m "Detailed commit message"
+    $ git push origin name-of-feature
+
+3. Before submitting a pull request, check the following:
+
+- If the pull request adds functionality, it is tested and the docs are updated.
+
+4. Submit a pull request to ``flask-apispec:master``. The `CI <https://travis-ci.org/jmcarp/flask-apispec>`_ build must be passing before your pull request is merged.
+
+Running tests
+*************
+TODO: Actually verify these commands
+To run all tests: ::
+
+    $ pytest
+
+To run syntax checks: ::
+
+    $ tox -e lint
+
+(Optional) To run tests in all supported Python versions in their own virtual environments (must have each interpreter installed): ::
+
+    $ tox
+
+.. _contributing_documentation:
+
+Documentation
+*************
+TODO: Make these commands accurate. (using invoke)
+Contributions to the documentation are welcome. Documentation is written in `reStructured Text`_ (rST). A quick rST reference can be found `here <https://docutils.sourceforge.net/docs/user/rst/quickref.html>`_. Builds are powered by Sphinx_.
+
+To build the docs: ::
+
+   $ invoke docs build
+
+
+.. _contributing_examples:
+
+Contributing Examples
+*********************
+
+Have a usage example you'd like to share? Feel free to add it to the `examples <https://github.com/marshmallow-code/marshmallow/tree/dev/examples>`_ directory and send a pull request.
+
+
+.. _Sphinx: https://www.sphinx-doc.org/
+.. _`reStructured Text`: http://docutils.sourceforge.net/rst.html
+.. _flask-apispec: https://github.com/jmcarp/flask-apispec
\ No newline at end of file