Skip to content

Latest commit

 

History

History
40 lines (33 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

40 lines (33 loc) · 1.92 KB

Contributing to iFTL

✨ First off all, thanks for taking the time to contribute! ✨

The following is a set of guidelines for contributing to iFTL an open source decentralized finance project, which is hosted in the Tachyonic FInance Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

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
  • Consider starting the commit message with an applicable emoji:
    • 🎨 :art: when improving the format/structure of the code
    • 🚀 :rocket: when improving performance
    • 🤖 :robot: when improving the AI
    • 📝 :memo: when writing docs
    • 🐧 :penguin: when fixing something related to Linux
    • 🍎 :apple: when fixing something related to macOS
    • 🐛 :bug: when fixing a bug
    • 💡 :bulb: new idea
    • 🚧 :construction: work in progress
    • :heavy_plus_sign: when adding feature
    • :heavy_minus_sign: when removing feature
    • 🔈 :speaker: when adding logging
    • 🔇 :mute: when reducing logging
    • 🔥 :fire: when removing code or files
    • :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