Skip to content

Latest commit

 

History

History
46 lines (38 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

46 lines (38 loc) · 1.85 KB

Contributing

First off, thanks for taking the time to contribute!

How can I contribute?

  • Fork this project;
  • Make your changes / new implementatios;
  • Use the pattern for git commts;
  • Make sure that the acceptance criteria are met (tests, docs, etc);
  • Create a pull request;

Pull Requests

Template PULL_REQUEST_TEMPLATE

Git Commit Messages

  • Use the present tense ("Adds feature" not "Added feature")
  • 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
    • 💡 :bulb: new idea
    • 🚧 :construction: work in progress
    • :heavy_plus_sign: when adding features
    • :heavy_minus_sign: when removing features
    • 🔈 :mute: when adding logging
    • 🔇 :mute: when reducing logging
    • 👊 :facepunch: when resolve conflict
    • 🔧 :wrench: when modify Web.config