Styleguides

Using the atom model

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 description
Consider starting the commit message with an applicable emoji:
- 🎨 :art: when changed CSS, Images, Layout
- 🔤 :abc: 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
- 🔨 :hammer: when adding new features
- 🔒 :lock: when dealing with security
- ⬆️ :arrow_up: when upgrading dependencies
- ⬇️ :arrow_down: when downgrading dependencies
- 👕 :shirt: when removing linter warnings

Documentation Styleguide

Use AtomDoc.
Use Markdown.
Reference methods and classes in markdown with the custom {} notation:
- Reference classes with {ClassName}
- Reference instance methods with {ClassName::methodName}
- Reference class methods with {ClassName.methodName}

Example of commit message

emoji BASE OR Example #ISSUE (FIXED) {ClassName.methodName} text comment