Skip to content

Commit 581ba7c

Browse files
FAQ.rst:Replace a FAQ
Replaces FAQ: 'What are these passing/failing tests on my PRs?' --> 'Need help contributing to coala?' closes: coala#552
1 parent 71c5e48 commit 581ba7c

File tree

1 file changed

+5
-35
lines changed

1 file changed

+5
-35
lines changed

Help/FAQ.rst

+5-35
Original file line numberDiff line numberDiff line change
@@ -113,41 +113,11 @@ a newer pip:
113113
should do the job. You have to activate this virtualenv on every terminal
114114
session you want to use coala though (tip: add it to bashrc!)
115115

116-
What are those things failing/passing on my Pull Request?
117-
---------------------------------------------------------
118-
119-
We use a few checks to make sure your Pull Request is ready to be merged into
120-
our master branch. Right now we use 7 of those checks:
121-
122-
- **review/gitmate/commit** Checks this particular commit has any new gitmate
123-
issues.
124-
125-
- **review/gitmate/pr** Checks whether your code respects our styling (PEP8),
126-
doesn't contain unneeded newlines, trailing whitespace, etc. Basically it is
127-
like running coala over your code, so to fix this, simply run ``$ coala``
128-
before pushing! In case you have multiple commits, and the issue is in one
129-
of them, the status will still be failed, so be careful to run ``$ coala``
130-
before making each commit.
131-
132-
- **review/gitmate/manual** This one is the only one that is manual, this can
133-
be given by any coala member and shows that the commit has been reviewed and
134-
has no problems, so it is ready to be merged. It can be done by commenting
135-
``ack commit_sha``. For more information about the whole process, we have
136-
it all documented
137-
`here <http://api.coala.io/en/latest/Developers/Review.html>`_.
138-
139-
- **codecov/project** This one checks whether all your code is being tested. We
140-
cannot merge anything that may not work or may broke somewhere, so to avoid
141-
obvious bugs we use this. To fix it, write doctests or unittests for your
142-
functions / classes.
143-
144-
- **ci/circleCI** This is one of the two containers we use to continuously
145-
test the code. It basically runs all the tests and checks your code in a
146-
container, checking that the tests pass on the container. This one is for
147-
Linux, it runs Ubuntu 12.04.
148-
149-
- **continuous-integration/appveyor/pr** This one does the same as the one
150-
above, but for Windows, both 32 and 64bits versions.
116+
Need help contributing to coala?
117+
--------------------------------
118+
119+
If you're new to coala or need any help contributing to coala,please
120+
checkout the `coala API documentation <http://api.coala.io/en/latest/>`_.
151121

152122
What is coala Community Code of Conduct?
153123
----------------------------------------

0 commit comments

Comments
 (0)