search

pre-commit-ci / issues

public issues for https://pre-commit.ci
16 stars 3 forks source link

Change badge wording from "passed" to "passing" #82

Closed peterjc closed 3 years ago

peterjc commented 3 years ago

Currently on successful runs, pre-commit.ci uses the wording "passed" (which is actually accurate as it reports the latest finished test), while most other services use "passing" instead.

Example with pre-commit.ci and two badges from Shields.io:

Screenshot 2021-08-26 at 15 52 31

See also:

https://docs.readthedocs.io/en/stable/badges.html

https://docs.travis-ci.com/user/status-images/

https://circleci.com/docs/2.0/status-badges/ (for their shield style)

https://www.appveyor.com/docs/status-badges/ (they have configurable status text, see also #81)

peterjc commented 3 years ago

P.S. I've not checked as many badges, but I think the consensus is on error is "failing" in red.

peterjc commented 3 years ago

Also GitHub Actions uses "passing" and "failing":

https://docs.github.com/en/actions/managing-workflow-runs/adding-a-workflow-status-badge

asottile commented 3 years ago

circle ci, azure pipelines, and gitlab uses "passed" -- "passed" / "failed" / "errored" is also consistent with how pre-commit.ci displays run results

peterjc commented 3 years ago

Fair enough - the CI badges are not as one-sided on this naming divide as I thought.