Skip to content

Latest commit

 

History

History
31 lines (30 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

31 lines (30 loc) · 1.99 KB

Contribute and share :)

  1. Fork this project
  • Create a new feature/patch branch
  • Code code code
  • run grunt to ensure the uglify, css minify, jshint, csslint and jscs pass
  • Write a good commit message with some guidelines here:
    1. 5 useful tips for better commit message
    • angularjs commit message guideline with format <type>(<scope>): <subject>
    • 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 as inspired by atom guidelines:
      • 🎨 :art: when improving the format 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
  • Pull request using the new feature/patch branch
  • Ensure the Travis build passes