Skip to content

geniuxconsulting/guideline

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 

Repository files navigation

This are some guidelines we came up at Geniux when dealing with code. It is heavily based on the contributing guideline of Github's Atom editor with some minor changes (mostly in the emoji section with adding emojis for Bitbucket where there are no Github equivalents).

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

Consider starting the commit message with an applicable emoji:

  • 🎨 when improving the format/structure of the code
  • 🐎 when improving performance
  • 🚱 when plugging memory leaks (Bitbucket 🔞)
  • 📝 when writing docs
  • 🐧 when fixing something on Linux
  • 🍎 when fixing something on Mac OS
  • 🏁 when fixing something on Windows (Bitbucket 💂‍♂️)
  • 🐛 when fixing a bug
  • 🔥 when removing code or files
  • 💚 when fixing the CI build (Bitbucket 💗)
  • ✅ when adding tests (Bitbucket 🆗)
  • 🔒 when dealing with security
  • ⬆️ when upgrading dependencies (Bitbucket 🆙)
  • ⬇️ when downgrading dependencies (Bitbucket :thumsdown:)
  • 👕 when removing linter warnings
  • 🐗 when updating task runner
  • 🚢 Deployment

About

Commit & general guidelines when dealing with code

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published