All Contributors configuration file

The configuration file used by the All Contributors CLI and GitHub bot

Type object
File match .all-contributorsrc
Schema URL https://catalog.lintel.tools/schemas/schemastore/all-contributors-configuration-file/latest.json
Source https://www.schemastore.org/all-contributors.json

Validate with Lintel

npx @lintel/lintel check
Type: object

The configuration file used by the All Contributors CLI and GitHub bot. https://allcontributors.org/docs/en/bot/configuration

Properties

projectName string required
minLength=0
projectOwner string required
minLength=0
repoType enum
Default: "github"
Values: "github" "gitlab"
repoHost string

Change it if you use a self-hosted repository. Default: https://github.com if repoType is github, and https://gitlab.com if repoType is gitlab

minLength=0
files string[]
Default:
[
  "README.md"
]
imageSize number
Default: 100
min=0
commit boolean
Default: false
commitConvention enum
Default: "angular"
Values: "angular" "atom" "ember" "eslint" "jshint" "gitmoji" "none"
commitType string

UNDOCUMENTED: Sets Conventional Commits commit type to be used by the all contributors bot. See https://www.conventionalcommits.org.

Default: "docs"
contributorsPerLine number
Default: 7
min=0
contributorsSortAlphabetically boolean
Default: false
badgeTemplate string
minLength=0
contributorTemplate string
minLength=0
types Record<string, object>
linkToUsage boolean
Default: true
skipCi boolean
Default: true
contributors object[]