Skip to content

Conventions

Oculux edited this page Jul 16, 2024 · 5 revisions

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!)

Issues and Bug Reports

These will be created by Yvonne and Nate for now, but stay tuned for later!

Branches

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

Commits

:gitmoji: presentTenseVerb description
E.g. :sparkles: implement dashboard component :bug: fix home image not loading

Here are the most common gitmojis: (see more here)

  1. :sparkles: new feature
  2. 💄 :lipstick: UI change
  3. 🧱 :bricks: repository architecture
  4. :zap: performance improvement
  5. 🐛 :bug: bug fix
  6. 🎨 :art: code style, linting
  7. 🧪 :test_tube: edited tests
  8. 🔧 :wrench: config change
  9. 📝 :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.

Pull Requests

Title: same as issue.

Everything else is templated for you!

Clone this wiki locally