Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Executing_Tests.rst: Improve getting started part #473

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions Developers/Executing_Tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,26 +9,27 @@ Executing our Tests
coala has a big test suite. It is meant to work on every platform on
every PC. If you just execute our tests you are doing us a favor.

To run tests, You first need to install some dependencies.
This can be done by following these steps:
To run tests, you will need to open a file located in the default coala
directory.

If you have not already, clone the
`repository <https://github.com/coala-analyzer/coala>`_ (or a fork of
it) by running:
If you have not already, you can start by cloning a copy of the project to
your local machine.

Either fork the repo on Github https://github.com/coala-analyzer/coala,
or clone it directly from coala.

::

$ git clone https://github.com/coala-analyzer/coala.git

Navigate to the directory where coala is located.
Then navigate to the directory where coala is located.

Next you need to install some requirements. This can be
done by executing the following command while in the root of the
coala project directory.
Next you need to install some dependencies. This can be
done by executing:

::

$ pip3 install -r test-requirements.txt -r requirements.txt
$ pip3 install -r test-requirements.txt -r requirements.txt

You can then execute our tests with

Expand Down