Skip to content

Commit 3ceb281

Browse files
committed
Better overall docs
1 parent 60f38c6 commit 3ceb281

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

content/v3/repos/statuses.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,19 @@ title: Statuses | GitHub API
44

55
# Repo Statuses API
66

7-
The status API allows external services to mark commits as success,
8-
failure, error, or pending, depending on whatever criteria that service
9-
dictactes. For example, one common use is for continuous integration
10-
services to mark commits as passing or failing builds using Status.
7+
The status API allows external services to mark commits with a success,
8+
failure, error, or pending `state`, which is then reflected in pull requests involving
9+
those commits.
10+
11+
Statuses can also include an optional `description` and `url`, and
12+
we highly recommend providing them as they make statuses much more
13+
useful in the GitHub UI.
14+
15+
As an example, one common use is for continuous integration
16+
services to mark commits as passing or failing builds using Status. The
17+
`target_url` would be the full url to the build output, and the
18+
description would be the high level summary of what happened with the
19+
build.
1120

1221
## List Statuses for a specific SHA
1322

0 commit comments

Comments
 (0)