jimiguo / terracotta-platform

terracotta-platform

For Developers

License Headers

This project uses the license-maven-plugin to make sure all license headers are present (including all java and xml files) and conform to the root header.txt (Apache 2 License) Whenever you add a new file, you can automatically have the header added using, at the root level :

mvn com.mycila:license-maven-plugin:format

Otherwise, you would get such an error while building :

[ERROR] Failed to execute goal com.mycila:license-maven-plugin:3.0.rc1:check (default) on project platform-root: Some files do not have the expected license header -> [Help 1]

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:

  • 🎨 :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

  • 🍎 :apple: when fixing something on Mac OS

  • 🏁 :checkered_flag: when fixing something on Windows

  • 🐛 :bug: when fixing a bug

  • 🔥 :fire: when removing code or files

  • 💚 :green_heart: when fixing the CI build

  • ✅ :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

  • 🔈 :speaker: when adding logging

  • 🔇 :mute: when reducing logging

  • 💡 :bulb: new idea

  • 🚧 :construction: work in progress

  • ➕ :heavy_plus_sign: when adding feature

  • ➖ :heavy_minus_sign: when removing feature

  • ❄️ :snowflake: when changing configuration, setting, build file, etc

(adapted from Atom guidelines)