Styleguide (EN)

Styleguides

Git Commit Messages

• Use the present tense ("Add feature" not "Added feature")
• Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
• Limit the first line to 72 characters or less
• Reference issues and pull requests liberally after the first line
• When only changing documentation, include [ci skip] in the commit title
• Consider starting the commit message with an applicable emoji:
  • 🎨 :art: when improving the format/structure of the code
  • 🐎 :racehorse: when improving performance
  • 🚱 :non-potable_water: when plugging memory leaks
  • 📝 :memo: when writing docs
  • 🐧 :penguin: when fixing something on Linux
  • 🌱 :checkered_flag: when fixing something on Bramble
  • 🐛 :bug: when fixing a bug
  • 🔥 :fire: when removing code or files
  • ✅ :white_check_mark: when adding tests
  • 🔒 :lock: when dealing with security
  • ⬆️ :arrow_up: when upgrading dependencies
  • ⬇️ :arrow_down: when downgrading dependencies
  • 👕 :shirt: when removing linter warnings
  • 🌳 :deciduous_tree: when adding a category
  • 🌰 :chestnut: when adding a feature
  • 🍭 :lollipop: when improving the user interface

Color in Bramble

Some colors are used in Bramble and they have a sens :

• red : error or important warning
• green : success
• yellow : be carefull
• blue : information
• big : important
• reverse : selected item