EventBus/docs/CONTRIBUTING.md
Dawid Drozd eddf87ae48 Add contributing doc
[ci skip]

Change-Id: I53dde8bbfcf6c339192e0dd8aefdf219bd694b6f
2018-10-15 14:48:35 +01:00

2.0 KiB

How Can I Contribute?

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Just do it we will work out something ;) Just try to keep good quality of your work.

Styleguides

Common Convencions

  • Use tabs instead spaces (tab = 4 spaces)

Git Commit Messages

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."
  • 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 message
  • 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 macOS
    • 🏁 :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

C++ Styleguide

Style is definied in clang-format file, so please just run `clang-format in root directory :) Style now should be fine.

In other cases please follow style form older peaces of code :)

Thanks