-
Notifications
You must be signed in to change notification settings - Fork 1
Conventions
Please follow these conventions! They'll let us do things like easily match issues with PRs and guess branch names for PRs without having to actually look them up on GitHub (which trust me, you'll get tired of real quick!)
You can find them on the Kanban Board.
issuenum Issue Name
e.g. 001 Set Up Repository
issuenum_lowercase-issue-name
e.g. 001_set-up-repository
If not related to an issue, leave off the number and choose a good, concise name e.g. _home-page-crashing
:gitmoji: presentTenseVerb description
E.g. :sparkles: implement dashboard component
:bug: fix home image not loading
Here are the most common gitmojis: (see more here)
- ✨
:sparkles:
new feature - 💄
:lipstick:
UI change - 🧱
:bricks:
repository architecture - ⚡
:zap:
performance improvement - 🐛
:bug:
bug fix - 🎨
:art:
code style, linting - 🧪
:test_tube:
edited tests - 🔧
:wrench:
config change - 📝
:memo:
other minor edit, e.g. renaming
Overlap should be rare if you're only changing one thing per commit, but sometimes it happens - just use your judgment to choose the best one.
Title: same as issue.
Everything else is templated for you!