Skip to content

Latest commit

 

History

History
60 lines (52 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

60 lines (52 loc) · 2.48 KB

First of all , Thank you for considering contributing to cello.
Here are some of the ways you can help out:

  • ✨ Report a bug
  • 🔨 fix a good first issue
  • 🔨 fix a todo issue
  • 🔨 Look at bugs with the need triage label

bug reporting


Make sure your issue is reprodusible and is notabug. check if your cello is modified. check if the issue already is open. Just a cursory search , that's all.

pull requests


Make sure your pull adheres to the style guide

Style


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 30 charecters or less.Aditional info 📝 in the description
  • Reference issues and pull requests liberally after the first line
  • When only changing documentation, include [ci skip] in the commit title
  • Consider starting the commit message with an applicable emoji:
    • 🎨 :art: when improving the format/structure of the code
    • 🐎 :zap: when improving performance
    • 📝 :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 fixing linter warnings
    • 🚌 :bus: when adding a feature
    • ⚙️ :gear: when changing configs of anything
    • 🚀 :rocket: when launching a release , or prepping for a release
    • 🍻 :beers: when optimizing something
    • 🍺 :beer: write code drunkenly
    • 👥:busts_in_silhouette: when adding contributers
    • 🔀 :twisted_tightwards_arrows:when merging
    • 📦 :package: when doing something with packages
    • 💾 :floppy_disk: when doing something with install
    • you can usually find a similar spec in gitmoji.dev

Ruby style guide


 * use inline if/else when ever possible
 * try not to use (brackets) when calling functions