Skip to content

Latest commit

Β 

History

History
37 lines (30 loc) Β· 1.83 KB

CONTRIBUTING.md

File metadata and controls

37 lines (30 loc) Β· 1.83 KB

Contributing to Source

First off, thanks for taking the time to contribute! πŸŽ‰πŸ’–

The following is a set of guidelines for contributing to the fandom.gallery Source, and it's packages, which are hosted in the Fandom-Gallery Organization on Github. These are mostly guidelines, not rules. Use your best judgement and feel free to propose changes to this Document in our Discussion

Styleguides

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 [skip ci] in the commit title
  • Consider including the Project in your commit message ("<emoji> - <project> - <msg>)
  • 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