Skip to content
Open
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
94 changes: 50 additions & 44 deletions docs/emoji-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,47 +4,53 @@ title: Emoji Key ✨ (and Contribution Types)
sidebar_label: Emoji Key ✨
---

## Table

> To have a contribution added when using the [Bot](bot/overview) or [CLI](cli/overview) use the keyword in the `Type` column. The bot will also use [basic Natural Language Parsing](https://github.com/all-contributors/app/blob/main/lib/parse-comment.js) to determine your contribution intent.

Emoji/Type | Represents | Comments |
:---: | :---: | :---: |
🔊 <br /> `audio` | Audio | Podcasts, background music or sound effects |
♿️ <br /> `a11y` | Accessibility | Reporting or working on accessibility issues |
🐛 <br /> `bug` | Bug reports | Links to issues reported by the user on this project |
📝 <br /> `blog` | Blogposts | Links to the blogpost |
💼 <br /> `business` | Business Development | People who execute on the business end |
💻 <br /> `code` | Code | Links to commits by the user on this project |
🖋 <br /> `content` | Content | e.g. website copy, blog posts are separate |
🔣 <br /> `data` | Data | Links to contributed data for the project (both tests and datasets) |
📖 <br /> `doc` | Documentation | Links to commits by the user on this project, Wiki, or other source of documentation |
🎨 <br /> `design` | Design | Links to the logo/iconography/visual design/etc. |
💡 <br /> `example` | Examples | Links to the examples |
📋 <br /> `eventOrganizing` | Event Organizers | Links to event page |
💵 <br /> `financial` | Financial Support | People or orgs who provide financial support, links to relevant page
🔍 <br /> `fundingFinding` | Funding/Grant Finders | People who help find financial support
🤔 <br /> `ideas` | Ideas & Planning | Open up issues |
🚇 <br /> `infra` | Infrastructure | Hosting, Build-Tools, etc. Links to source file (like `travis.yml`) in repo, if applicable
🚧 <br /> `maintenance` | Maintenance | People who help in maintaining the repo, links to commits by the user on this project
🧑‍🏫 <br /> `mentoring` | Mentoring | People who mentor new contributors, links to the repo home
📦 <br /> `platform` | Packaging | Porting to support a new platform |
🔌 <br /> `plugin` | Plugin/utility libraries | Links to the repo home
📆 <br /> `projectManagement` | Project Management | Organize team meetings, take minutes, set timelines, etc. |
📣 <br /> `promotion` | Promotion | Social media |
💬 <br /> `question` | Answering Questions | Answering Questions in Issues, Stack Overflow, Gitter, Slack, etc.
🔬 <br /> `research` | Research | Literature review.
👀 <br /> `review` | Reviewed Pull Requests | |
🛡️ <br /> `security` | Security | Identify and/or reduce security threats, GDPR, Privacy, etc |
🔧 <br /> `tool` | Tools | Links to the repo home |
🌍 <br /> `translation` | Translation | Links to the translated content |
⚠️ <br /> `test` | Tests | Links to commits by the user on this project |
✅ <br /> `tutorial` | Tutorials | Links to the tutorial |
📢 <br /> `talk` | Talks | Links to the slides/recording/repo/etc |
📓 <br /> `userTesting` | User Testing | Links to user test notes |
📹 <br /> `video` | Videos | Links to the video |

## What's next

- [Notes for repository maintainers](repository-maintainers)
- [Automating the process using tools](tooling)
# Emoji Key ✨ (Contribution Types)

This document serves as a guide for recognizing different types of contributions to the project. To ensure your contribution is properly acknowledged, use the appropriate keyword in the `Type` column when submitting contributions via the [Bot](bot/overview) or [CLI](cli/overview). The bot also uses [Natural Language Parsing](https://github.com/all-contributors/app/blob/master/lib/parse-comment.js) to identify your contribution type.

## Contribution Types and Emoji Guide

| Emoji | Type | Represents | Comments |
| :---: | :--- | :--- | :--- |
| 🔊 | `audio` | Audio | Contributions related to podcasts, background music, or sound effects. |
| ♿️ | `a11y` | Accessibility | Reporting or working on accessibility-related issues. |
| 🐛 | `bug` | Bug Reports | Links to issues or bugs reported in the project. |
| 📝 | `blog` | Blogposts | Writing and sharing blog posts. |
| 💼 | `business` | Business Development | Executing tasks related to business development. |
| 💻 | `code` | Code | Contributions to code, including commits and pull requests. |
| 🖋 | `content` | Content | Writing content like website copy, blog posts, etc. |
| 🔣 | `data` | Data | Contributing to the project's datasets, including tests and raw data. |
| 📖 | `doc` | Documentation | Creating or editing project documentation, including README, Wiki, or API docs. |
| 🎨 | `design` | Design | Contributions related to visual design, branding, UI/UX improvements, etc. |
| 💡 | `example` | Examples | Providing examples of how to use the project. |
| 📋 | `eventOrganizing` | Event Organizing | Organizing and promoting events for the project. |
| 💵 | `financial` | Financial Support | People or organizations who provide financial support. |
| 🔍 | `fundingFinding` | Funding/Grant Finding | Helping find financial support or grants. |
| 🤔 | `ideas` | Ideas & Planning | Suggesting or planning new ideas and features. |
| 🚇 | `infra` | Infrastructure | Hosting, CI/CD, and build tools related contributions. |
| 🚧 | `maintenance` | Maintenance | Maintaining and updating the repository or project. |
| 🧑‍🏫 | `mentoring` | Mentoring | Mentoring new contributors or guiding them in their contributions. |
| 📦 | `platform` | Platform Support | Porting the project to support a new platform. |
| 🔌 | `plugin` | Plugin/Utility Libraries | Contributions to plugin libraries or utilities. |
| 📆 | `projectManagement` | Project Management | Managing project timelines, tasks, and resources. |
| 📣 | `promotion` | Promotion | Promoting the project through social media or other platforms. |
| 💬 | `question` | Answering Questions | Responding to questions on issues, forums, or chats. |
| 🔬 | `research` | Research | Conducting research or literature reviews to help improve the project. |
| 👀 | `review` | Reviewed Pull Requests | Reviewing and approving pull requests. |
| 🛡️ | `security` | Security | Identifying and resolving security threats or ensuring GDPR and privacy compliance. |
| 🔧 | `tool` | Tools | Creating or maintaining project-related tools. |
| 🌍 | `translation` | Translation | Translating content to different languages for global accessibility. |
| ⚠️ | `test` | Tests | Writing or updating test cases for the project. |
| ✅ | `tutorial` | Tutorials | Creating tutorials to guide new users or contributors. |
| 📢 | `talk` | Talks | Sharing talks, presentations, or webinars about the project. |
| 📓 | `userTesting` | User Testing | Conducting or documenting user testing results. |
| 📹 | `video` | Videos | Creating or contributing to project-related videos. |

## What's Next

Once you’ve contributed, check out the following resources to further your contribution or engage with the community:

- [Notes for Repository Maintainers](repository-maintainers)
- [Automating the Process Using Tools](tooling)


Loading