docs: add description about CI platforms to CONTRIBUTE.md

Reviewed-by: Daniel Stenberg
Reviewed-by: Marcel Raad
Reviewed-by: Jay Satiro

Closes #5882
This commit is contained in:
Marc Hoersken 2020-08-29 09:56:22 +02:00
parent 8bb183114c
commit 61aab81c5c
No known key found for this signature in database
GPG Key ID: 61E03CBED7BC859E

View File

@ -172,6 +172,33 @@ you are expected to fix the problem. If you don't understand when the issue is
or have other problems to fix the complaint, just ask and other project
members will likely be able to help out.
Consider the following table while looking at pull request failures:
| CI platform as shown in PR | State | What to look at next |
| ----------------------------------- | ------ | -------------------------- |
| CI / codeql | stable | quality check results |
| CI / fuzzing | stable | fuzzing results |
| CI / macos ... | stable | all errors and failures |
| Code scanning results / CodeQL | stable | quality check results |
| FreeBSD FreeBSD: ... | stable | all errors and failures |
| LGTM analysis: Python | stable | new findings |
| LGTM analysis: C/C++ | stable | new findings |
| buildbot/curl_winssl_ ... | stable | all errors and failures |
| continuous-integration/appveyor/pr | stable | all errors and failures |
| continuous-integration/travis-ci/pr | stable | all errors and failures |
| curl.curl (linux ...) | stable | all errors and failures |
| curl.curl (windows ...) | flaky | repetitive errors/failures |
| deepcode-ci-bot | stable | new findings |
| musedev | stable | new findings |
Sometimes the tests fail due to a dependency service temporarily being offline
or otherwise unavailable, eg. package downloads. In this case you can just
try to update your pull requests to rerun the tests later as described below.
You can update your pull requests by pushing new commits or force-pushing
changes to existing commits. Force-pushing an amended commit without any
actual content changed also allows you to retrigger the tests for that commit.
When you adjust your pull requests after review, consider squashing the
commits so that we can review the full updated version more easily.