Skip to content

Commit 3cf3c02

Browse files
authored
docs: prefer dynamic badge over bot-updated static badge (#406) (#672)
h/t @JoeIzzard for the Shields contribution
1 parent 31b6508 commit 3cf3c02

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

3030
[![Build Status](https://img.shields.io/circleci/project/all-contributors/all-contributors/master.svg)](https://circleci.com/gh/all-contributors/workflows/all-contributors/tree/master)
3131
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/all-contributors/localized.svg)](https://crowdin.com/project/all-contributors)
32-
[![All Contributors](https://img.shields.io/badge/all_contributors-54-orange.svg?style=flat-square)](#contributors-)
32+
[![All Contributors](https://img.shields.io/github/all-contributors/all-contributors/all-contributors?color=ee8449&style=flat-square)](#contributors-)
3333
[![Netlify Status](https://api.netlify.com/api/v1/badges/e30784c5-9efd-4f20-8a47-13f3fb899613/deploy-status)](https://app.netlify.com/sites/allcontributors-org/deploys)
3434
[![Star on GitHub](https://img.shields.io/github/stars/all-contributors/all-contributors.svg?style=social)](https://github.com/all-contributors/all-contributors/stargazers)
3535

docs/bot/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ These are the keys you can specify:
4242
"commit": false,
4343
"contributorsPerLine": 7,
4444
"contributorsSortAlphabetically": false,
45-
"badgeTemplate": "[![All Contributors](https://img.shields.io/badge/all_contributors-<%= contributors.length %>-orange.svg?style=flat-square)](#contributors)",
45+
"badgeTemplate": "[![All Contributors](https://img.shields.io/github/all-contributors/<%= projectOwner %>/<%= projectName %>?color=ee8449&style=flat-square)](#contributors)",
4646
"contributorTemplate": "<a href=\"<%= contributor.profile %>\"><img src=\"<%= contributor.avatar_url %>\" width=\"<%= options.imageSize %>px;\" alt=\"\"/><br /><sub><b><%= contributor.name %></b></sub></a>",
4747
"types": {
4848
"custom": {

docs/bot/faq.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,20 @@ sidebar_label: FAQs
66

77
### All Contributors badge count, does not update?
88

9-
To have the Badge update correctly, you must wrap your badge in start and end tags (as also done from the contribution table)
9+
To have the Badge update correctly, use the dynamic Shields badge.
1010

1111
#### Previously
1212

1313
```markdown
14+
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
1415
[![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors)
16+
<!-- ALL-CONTRIBUTORS-BADGE:END -->
1517
```
1618

1719
#### Now
1820

21+
Replace `projectOwner` with the relevant GitHub username or organization name, and `projectName` with the relevant the GitHub repo name. Style, color, and other parameters can be customized to your liking — see <https://shields.io/>.
22+
1923
```markdown
20-
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
21-
[![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors)
22-
<!-- ALL-CONTRIBUTORS-BADGE:END -->
24+
[![All Contributors](https://img.shields.io/github/all-contributors/projectOwner/projectName?color=ee8449&style=flat-square)](#contributors)
2325
```

docs/bot/installation.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,10 @@ For the list:
4343

4444
Note: Extra line is very important in order to make it work properly.
4545

46-
For the badge:
46+
For the badge use the following, replacing `projectOwner` with the relevant GitHub username or organization name, and `projectName` with the relevant the GitHub repo name. Style, color, and other parameters can be customized to your liking — see <https://shields.io/>.
4747

4848
```markdown
49-
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
50-
[![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors)
51-
<!-- ALL-CONTRIBUTORS-BADGE:END -->
49+
[![All Contributors](https://img.shields.io/github/all-contributors/projectOwner/projectName?color=ee8449&style=flat-square)](#contributors)
5250
```
5351

5452
## 4. Update your Contributing documentation

0 commit comments

Comments
 (0)