Skip to content

Latest commit

 

History

History
19 lines (17 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

19 lines (17 loc) · 1.13 KB

I do not expect many contributions for now, but I will use this document to gather any information which might be useful.

Git Commit Messages

It a great idea starting the commit message with an applicable emoji. This not only looks great but also makes you rethink what to add to a commit.

  • 🎉 :tada: when when adding a cool new feature
  • 🔧 :wrench: when refactoring / improving a small piece of code
  • 🔨 :hammer: when refactoring / improving large parts of the code
  • :sparkles: when applying clang-format
  • 🎨 :art: improving / adding assets like textures or 3D-models
  • 🚀 :rocket: when improving performance
  • 📝 :memo: when writing docs
  • 🪲 :beetle: when fixing a bug
  • 🚚 :truck: when when moving or renaming a file
  • 💚 :green_heart: when fixing the CI build
  • 🙈 :see_no_evil: when modifying the .gitignore file
  • :white_check_mark: when adding / updating tests
  • 🔼 :arrow_up_small: when adding / upgrading dependencies
  • 🔽 :arrow_down_small: when removing / downgrading dependencies