coala / coala/documentation

FAQ.rst: Two of the tests need to be changed.

Open
#589 10 comments 0 reactions 0 assignees View on GitHub
area/documentation difficulty/newcomer
Dominant language
Python
Stars
40
Forks
172
PR merge metrics
No merged PRs in 30d

Description

In the section "What are those things failing/passing on my Pull Request?" in Help/FAQ.rst, the descriptions of `codecov/project` and `ci/circleCI` should be replaced by those of `continuous-integration/travis-ci/pr` and `deploy/netlify`.

Currently, many newcomers' get confused on the failure of these tests and wonder if their changes cause them to fail. Thus, correcting the explanations of these tests might help them.

Contributor guide

No contributing guide indexed for this repository

Research direction

Open Help/FAQ.rst and locate the section “What are those things failing/passing on my Pull Request?”. Review the descriptions currently attached to codecov/project and ci/circleCI, then update that section to describe continuous-integration/travis-ci/pr and deploy/netlify. Done means the FAQ accurately explains those two checks for newcomers.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.