Contributing
May 30, 2021 ยท View on GitHub
We use https://allcontributors.org/ to recognize All Contributors. To add contributors to the table, write something in your PR or commit messages:
@all-contributors please add @<username> for <contributions>
Keep in mind
- This repository is very new, the developer experience is not that friendly. Help welcome!
- We haven't release a stable release yet, breaking changes are completely OK.
- The maintainer have a job&a kid. He will do his best to maintain the lib. If you want to co-maintain the repo, you are welcome.
Contribution labels
To have a contribution added when using the Bot or CLI use the keyword in the
Typecolumn. The bot will also use basic Natural Language Parsing to determine your contribution intent.
| Emoji/Type | Represents | Comments |
|---|---|---|
๐ audio | Audio | Podcasts, background music or sound effects |
โฟ๏ธ a11y | Accessibility | Reporting or working on accessibility issues |
๐ bug | Bug reports | Links to issues reported by the user on this project |
๐ blog | Blogposts | Links to the blogpost |
๐ผ business | Business Development | People who execute on the business end |
๐ป code | Code | Links to commits by the user on this project |
๐ content | Content | e.g. website copy, blog posts are separate |
๐ฃ data | Data | Links to contributed data for the project (both tests and datasets) |
๐ doc | Documentation | Links to commits by the user on this project, Wiki, or other source of documentation |
๐จ design | Design | Links to the logo/iconography/visual design/etc. |
๐ก example | Examples | Links to the examples |
๐ eventOrganizing | Event Organizers | Links to event page |
๐ต financial | Financial Support | People or orgs who provide financial support, links to relevant page |
๐ fundingFinding | Funding/Grant Finders | People who help find financial support |
๐ค ideas | Ideas & Planning | |
๐ infra | Infrastructure | Hosting, Build-Tools, etc. Links to source file (like travis.yml) in repo, if applicable |
๐ง maintenance | Maintenance | People who help in maintaining the repo, links to commits by the user on this project |
๐งโ๐ซ mentoring | Mentoring | People who mentor new contributors, links to the repo home |
๐ฆ platform | Packaging | Porting to support a new platform |
๐ plugin | Plugin/utility libraries | Links to the repo home |
๐ projectManagement | Project Management | |
๐ฌ question | Answering Questions | Answering Questions in Issues, Stack Overflow, Gitter, Slack, etc. |
๐ฌ research | Research | Literature review. |
๐ review | Reviewed Pull Requests | |
๐ก๏ธ security | Security | Identify and/or reduce security threats, GDPR, Privacy, etc |
๐ง tool | Tools | Links to the repo home |
๐ translation | Translation | Links to the translated content |
โ ๏ธ test | Tests | Links to commits by the user on this project |
โ
tutorial | Tutorials | Links to the tutorial |
๐ข talk | Talks | Links to the slides/recording/repo/etc |
๐ userTesting | User Testing | Links to user test notes |
๐น video | Videos | Links to the video |