Skip to content

Commit

Permalink
Update CONTRIBUTING.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
jettify committed Mar 19, 2016
1 parent 3b02288 commit 311ff57
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ In order to make a clone of the GitHub_ repo: open the link and press the

I hope everybody knows how to work with git and github nowadays :)

Workflow is pretty straightforward:
Work flow is pretty straightforward:

1. Clone the GitHub_ repo

Expand All @@ -47,7 +47,8 @@ Workflow is pretty straightforward:
Preconditions for running aioodbc test suite
---------------------------------------------

We expect you to use a python virtual environment to run our tests.
We expect you to use a python virtual environment and docker_ to run
our tests.

There are several ways to make a virtual environment.

Expand Down Expand Up @@ -79,9 +80,11 @@ We also recommend to install *ipdb* but it's on your own::

Congratulations, you are ready to run the test suite


Install database
----------------
TODO
You do not need to install any databases, docker_ will pull images and create
containers for you automatically, after the tests, containers will be removed.


Run aioodbc test suite
Expand All @@ -92,6 +95,10 @@ command::

$ make test

Or if you want to run only one particular test::

$ py.test tests/test_connection.py -k test_basic_cursor

The command at first will run the static and style checkers (sorry, we don't
accept pull requests with `pep8` or `pyflakes` errors).

Expand Down Expand Up @@ -141,3 +148,4 @@ After finishing all steps make a GitHub_ Pull Request, thanks.

.. _unixODBC: http://www.unixodbc.org/
.. _GitHub: https://github.com/aio-libs/aioodbc
.. _docker: https://docs.docker.com/engine/installation/

0 comments on commit 311ff57

Please sign in to comment.