Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify GitHub All Contributors badge #7690

Merged
merged 3 commits into from
Mar 6, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions services/github/github-all-contributors.service.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,17 @@ import Joi from 'joi'
import { renderContributorBadge } from '../contributor-count.js'
import { ConditionalGithubAuthV3Service } from './github-auth-service.js'
import { fetchJsonFromRepo } from './github-common-fetch.js'
import { documentation } from './github-helpers.js'
import { documentation as commonDocumentation } from './github-helpers.js'

const documentation = `
<p>
The All Contributors service allows you to recognize all your project
contributors, including those that don't push code. See
<a href="https://allcontributors.org">https://allcontributors.org</a>
for more information.
</p>
${commonDocumentation}
`

const schema = Joi.object({
contributors: Joi.array().required(),
Expand All @@ -17,7 +27,7 @@ export default class GithubAllContributorsService extends ConditionalGithubAuthV

static examples = [
{
title: 'Github All Contributors',
title: 'GitHub contributors (via allcontributors.org)',
namedParams: {
repo: 'all-contributors',
user: 'all-contributors',
Expand Down