CONTRIBUTORS.md Format

aid: contributors-md:format
name: CONTRIBUTORS.md Format
tags:
- Attribution
- Convention
- Markdown
- Recognition
image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
humanURL: https://allcontributors.org/
properties:
- url: https://allcontributors.org/
  type: Reference
- url: https://allcontributors.org/docs/en/specification
  type: Specification
- url: https://allcontributors.org/docs/en/emoji-key
  type: Documentation
- url: https://github.com/all-contributors/all-contributors
  type: Repository
description: The CONTRIBUTORS.md format is a Markdown convention that lists project contributors and the
  kinds of contribution they have made. Many projects adopt the All Contributors specification, which
  uses emoji keys to classify contributions, an embedded HTML table to render the contributor list, and
  a .all-contributorsrc JSON config file consumed by the All Contributors bot to automate updates.
x-features:
- Recognizes non-code contributions including design, docs, and review
- Compatible with the All Contributors emoji key specification
- Automatable through the All Contributors GitHub App or CLI
- Renders as an HTML table with avatars and contribution badges
- Pairs with CONTRIBUTING.md and CODE_OF_CONDUCT.md
x-useCases:
- Public attribution of every project contributor
- Recognizing accessibility, translation, and design contributions
- Automating contributor table updates via @all-contributors bot
- Demonstrating an inclusive open source community to sponsors
- Tracking contribution categories beyond commit history