- Pick a meaningful title for your pull request. (Use sentence case.)
- Prefix the title with an emoji to identify what is being done. (Copy-paste the emoji itself (not the :code:) from the list below.)
- Do not overuse punctuation in the title (like
(chore):
). - If it is helpful, use a simple prefix (like
ProjectX: Implement some feature
).
- Enter a succinct description that says why the PR is necessary, and what it does.
- Mention the GitHub issue that is being addressed by the pull request.
- The keywords
Fixes
,Closes
, orResolves
followed the issue number will automatically close the issue.
- Implement aspect X
- Leave out feature Y because of A
- Improve performance by B
- Improve accessibility by C
✨ New feature (:sparkles:
)
🐛 Bug fix (:bug:
)
🔥 P0 fix (:fire:
)
✅ Tests (:white_check_mark:
)
🚀 Performance improvements (:rocket:
)
🖍 CSS / Styling (:crayon:
)
♿ Accessibility (:wheelchair:
)
🌐 Internationalization (:globe_with_meridians:
)
📖 Documentation (:book:
)
🏗 Infrastructure / Tooling / Builds / CI (:building_construction:
)
⏪ Reverting a previous change (:rewind:
)
♻️ Refactoring (like moving around code w/o any changes) (:recycle:
)
🚮 Deleting code (:put_litter_in_its_place:
)