Update docs and README.rst

* #45: features.rst, add 'HTTP Request' section

* #45: features.rst, provide alternative, self contained example

* #45: features.rst, remove dummy data

* #45: features.rst, add newline at start of code example

* #45: features.rst, reduce example syntax

* add more project info badges

* update .gitignore

* move metadata to cfg file

* apply pre-commit hooks

* add link to contributing.rst to readme file

* update docs

* fix license filename

* fix typo

Co-authored-by: jeff levesque <[email protected]>

Author: northernSage

.gitignore

@@ -23,4 +23,7 @@ coverage.xml
 tests/junit.xml
 
 pytest_flask/_version.py
+
+# Editors
 .vscode
+.code-workspace

README.rst

@@ -1,7 +1,61 @@
 pytest-flask
 ============
 
-|PyPI version| |conda-forge version| |Python versions| |ci| |Documentation status|
+.. image:: https://img.shields.io/pypi/v/pytest-flask.svg
+    :target: https://pypi.python.org/pypi/pytest-flask
+    :alt: PyPi version
+
+.. image:: https://img.shields.io/conda/vn/conda-forge/pytest-flask.svg
+    :target: https://anaconda.org/conda-forge/pytest-flask
+    :alt: conda-forge version
+
+.. image:: https://github.com/pytest-dev/pytest-flask/workflows/build/badge.svg
+    :target: https://github.com/pytest-dev/pytest-flask/actions
+    :alt: CI status
+
+.. image:: https://img.shields.io/pypi/pyversions/pytest-flask.svg
+    :target: https://pypi.org/project/pytest-flask
+    :alt: PyPi downloads
+
+.. image:: https://readthedocs.org/projects/pytest-flask/badge/?version=latest
+   :target: https://pytest-flask.readthedocs.org/en/latest/
+   :alt: Documentation status
+
+.. image:: https://img.shields.io/maintenance/yes/2020?color=blue
+    :target: https://github.com/pytest-dev/pytest-flask
+    :alt: Maintenance
+
+.. image:: https://img.shields.io/github/last-commit/pytest-dev/pytest-flask?color=blue
+    :target: https://github.com/pytest-dev/pytest-flask/commits/master
+    :alt: GitHub last commit
+
+.. image:: https://img.shields.io/github/issues-pr-closed-raw/pytest-dev/pytest-flask?color=blue
+    :target: https://github.com/pytest-dev/pytest-flask/pulls?q=is%3Apr+is%3Aclosed
+    :alt: GitHub closed pull requests
+
+.. image:: https://img.shields.io/github/issues-closed/pytest-dev/pytest-flask?color=blue
+    :target: https://github.com/pytest-dev/pytest-flask/issues?q=is%3Aissue+is%3Aclosed
+    :alt: GitHub closed issues
+
+.. image:: https://img.shields.io/pypi/dm/pytest-flask?color=blue
+    :target: https://pypi.org/project/pytest-flask/
+    :alt: PyPI - Downloads
+
+.. image:: https://img.shields.io/github/languages/code-size/pytest-dev/pytest-flask?color=blue
+    :target: https://github.com/pytest-dev/pytest-flask
+    :alt: Code size
+
+.. image:: https://img.shields.io/badge/license-MIT-blue.svg?color=blue
+   :target: https://github.com/pytest-dev/pytest-flask/blob/master/LICENSE
+   :alt: License
+
+.. image:: https://img.shields.io/github/issues-raw/pytest-dev/pytest-flask.svg?color=blue
+   :target: https://github.com/pytest-dev/pytest-flask/issues
+   :alt: Issues
+
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+   :target: https://github.com/ambv/black
+   :alt: style
 
 An extension of `pytest`_ test runner which
 provides a set of useful tools to simplify testing and development
@@ -52,30 +106,11 @@ Contributing
 ------------
 
 Don’t hesitate to create a `GitHub issue`_ for any bug or
-suggestion.
-
-.. |PyPI version| image:: https://img.shields.io/pypi/v/pytest-flask.svg
-   :target: https://pypi.python.org/pypi/pytest-flask
-   :alt: PyPi version
-
-.. |conda-forge version| image:: https://img.shields.io/conda/vn/conda-forge/pytest-flask.svg
-   :target: https://anaconda.org/conda-forge/pytest-flask
-   :alt: conda-forge version
-
-.. |ci| image:: https://github.com/pytest-dev/pytest-flask/workflows/build/badge.svg
-   :target: https://github.com/pytest-dev/pytest-flask/actions
-   :alt: CI status
-
-.. |Python versions| image:: https://img.shields.io/pypi/pyversions/pytest-flask.svg
-   :target: https://pypi.org/project/pytest-flask
-   :alt: PyPi downloads
-
-.. |Documentation status| image:: https://readthedocs.org/projects/pytest-flask/badge/?version=latest
-   :target: https://pytest-flask.readthedocs.org/en/latest/
-   :alt: Documentation status
+suggestion. For more information check our contribution `guidelines`_.
 
 .. _pytest: https://docs.pytest.org/en/stable/
 .. _PyPI: https://pypi.python.org/pypi/pytest-flask
 .. _Github issue: https://github.com/vitalk/pytest-flask/issues
 .. _package documentation: http://pytest-flask.readthedocs.org/en/latest/
+.. _guidelines: https://github.com/pytest-dev/pytest-flask/blob/master/CONTRIBUTING.rst
 .. _application factory: https://flask.palletsprojects.com/en/1.1.x/patterns/appfactories/

docs/contributing.rst

@@ -1,32 +1,113 @@
 .. _contributing:
 
-Contributing
-============
+How to contribute
+=================
 
-Found a bug? Have an issue?
----------------------------
+All contributions are greatly appreciated!
 
-The fastest way to get feedback on contributions/bugs is create a `GitHub
-issue`_ or catch me on `Twitter`_.
+How to report issues
+~~~~~~~~~~~~~~~~~~~~
 
+Facilitating the work of potential contributors is recommended since it
+increases the likelihood of your issue being solved quickly. The few extra
+steps listed below will help clarify problems you might be facing:
 
-Code syntax and conventions
----------------------------
+-   Include a `minimal reproducible example`_ when possible.
+-   Describe the expected behaviour and what actually happened including a full
+    trace-back in case of exceptions.
+-   Make sure to list details about your environment, such as your platform,
+    versions of pytest, pytest-flask and python release.
 
-We try to conform to :pep:`8` as much as possible. Make sure that your code as
-well.
+Also, it's important to check the current open issues for similar reports
+in order to avoid duplicates.
 
+.. _minimal reproducible example: https://stackoverflow.com/help/minimal-reproducible-example
 
-Where are the tests?
---------------------
+Setting up your development environment
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Good that you’re asking. The repository test suite is located in ``tests``
-directory. Makefile defines a target to run them::
+-   Fork pytest-flask to your GitHub account by clicking the `Fork`_ button.
+-   `Clone`_ the main repository (not your fork) to your local machine.
 
-    make test
+    .. code-block:: text
 
-Ensure the all tests are passed before submitting a pull request.
+        $ git clone https://github.com/pytest-dev/pytest-flask
+        $ cd pytest-flask
 
+-   Add your fork as a remote to push your contributions.Replace
+    ``{username}`` with your username.
 
-.. _GitHub issue: https://github.com/vitalk/pytest-flask/issues
-.. _Twitter: https://twitter.com/elephantscanfly
+    .. code-block:: text
+
+        git remote add fork https://github.com/{username}/pytest-flask
+
+-   Using `Tox`_, create a virtual environment and install pytest-flask in editable mode with development dependencies.
+
+    .. code-block:: text
+
+        $ tox -e dev
+        $ source venv/bin/activate
+
+-   Install pre-commit hooks
+
+    .. code-block:: text
+
+        $ pre-commit install
+
+.. _Fork: https://github.com/pytest-dev/pytest-flask/fork
+.. _Clone: https://help.github.com/en/articles/fork-a-repo#step-2-create-a-local-clone-of-your-fork
+.. _Tox: https://tox.readthedocs.io/en/latest/
+
+Start Coding
+~~~~~~~~~~~~
+
+-   Create a new branch to identify what feature you are working on.
+
+    .. code-block:: text
+
+        $ git fetch origin
+        $ git checkout -b your-branch-name origin/master
+
+-   Make your changes
+-   Include tests that cover any code changes you make and run them
+    as described below.
+-   Push your changes to your fork.
+    `create a pull request`_ describing your changes.
+
+    .. code-block:: text
+
+        $ git push --set-upstream fork your-branch-name
+
+.. _create a pull request: https://help.github.com/en/articles/creating-a-pull-request
+
+How to run tests
+~~~~~~~~~~~~~~~~
+
+You can run the test suite for the current environment with
+
+    .. code-block:: text
+
+        $ pytest
+
+To run the full test suite for all supported python versions
+
+    .. code-block:: text
+
+        $ tox
+
+Obs. CI will run tox when you submit your pull request, so this is optional.
+
+Checking Test Coverage
+~~~~~~~~~~~~~~~~~~~~~~~
+
+To get a complete report of code sections not being touched by the
+test suite run ``pytest`` using ``coverage``.
+
+.. code-block:: text
+
+    $ coverage run -m pytest
+    $ coverage html
+
+Open ``htmlcov/index.html`` in your browser.
+
+More about converage `here <https://coverage.readthedocs.io>`__.