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 Type column. The bot will also use basic Natural Language Parsing to determine your contribution intent.

Emoji/TypeRepresentsComments
๐Ÿ”Š
audio
AudioPodcasts, background music or sound effects
โ™ฟ๏ธ
a11y
AccessibilityReporting or working on accessibility issues
๐Ÿ›
bug
Bug reportsLinks to issues reported by the user on this project
๐Ÿ“
blog
BlogpostsLinks to the blogpost
๐Ÿ’ผ
business
Business DevelopmentPeople who execute on the business end
๐Ÿ’ป
code
CodeLinks to commits by the user on this project
๐Ÿ–‹
content
Contente.g. website copy, blog posts are separate
๐Ÿ”ฃ
data
DataLinks to contributed data for the project (both tests and datasets)
๐Ÿ“–
doc
DocumentationLinks to commits by the user on this project, Wiki, or other source of documentation
๐ŸŽจ
design
DesignLinks to the logo/iconography/visual design/etc.
๐Ÿ’ก
example
ExamplesLinks to the examples
๐Ÿ“‹
eventOrganizing
Event OrganizersLinks to event page
๐Ÿ’ต
financial
Financial SupportPeople or orgs who provide financial support, links to relevant page
๐Ÿ”
fundingFinding
Funding/Grant FindersPeople who help find financial support
๐Ÿค”
ideas
Ideas & Planning
๐Ÿš‡
infra
InfrastructureHosting, Build-Tools, etc. Links to source file (like travis.yml) in repo, if applicable
๐Ÿšง
maintenance
MaintenancePeople who help in maintaining the repo, links to commits by the user on this project
๐Ÿง‘โ€๐Ÿซ
mentoring
MentoringPeople who mentor new contributors, links to the repo home
๐Ÿ“ฆ
platform
PackagingPorting to support a new platform
๐Ÿ”Œ
plugin
Plugin/utility librariesLinks to the repo home
๐Ÿ“†
projectManagement
Project Management
๐Ÿ’ฌ
question
Answering QuestionsAnswering Questions in Issues, Stack Overflow, Gitter, Slack, etc.
๐Ÿ”ฌ
research
ResearchLiterature review.
๐Ÿ‘€
review
Reviewed Pull Requests
๐Ÿ›ก๏ธ
security
SecurityIdentify and/or reduce security threats, GDPR, Privacy, etc
๐Ÿ”ง
tool
ToolsLinks to the repo home
๐ŸŒ
translation
TranslationLinks to the translated content
โš ๏ธ
test
TestsLinks to commits by the user on this project
โœ…
tutorial
TutorialsLinks to the tutorial
๐Ÿ“ข
talk
TalksLinks to the slides/recording/repo/etc
๐Ÿ““
userTesting
User TestingLinks to user test notes
๐Ÿ“น
video
VideosLinks to the video