Skip to content

Latest commit

 

History

History
51 lines (42 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

51 lines (42 loc) · 2.66 KB
Raw

Contributing to Autocomplete SQL

Thank you for taking the time to contribute! 👍

These are guidelines, not rules. Use your best judgment. Feel free to propose changes to this document in a pull request.

All contributors will be listed in Contributors.

Code of Conduct

Please remember that all participants, are expected to uphold the Code of Conduct. Please report unacceptable behavior by submitting an issue with a conduct label.

How to Contribute

Reporting Bugs

Please read and use the Issue Template.

Suggesting Features or Enhancements

Please submit an issue with a suggest label to suggest a feature or enhancement.

Documentation

Please be concise in writing documentation and use Markdown. Command line instructions are preferred over GUI information. Please use the documentation label.

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 [ci skip] in the commit description
  • Consider starting the commit message with an applicable emoji:
    • 🎨 :art: when writing code or improving it
    • 🐎 :racehorse: when improving performance
    • 🚱 :non-potable_water: when plugging memory leaks
    • 📝 :memo: when writing docs
    • 🐛 :bug: when fixing a bug
    • 🔥 :fire: when removing code or files
    • 💚 :green_heart: when fixing the CI build
    • ✅ :white_check_mark: when adding tests
    • 👕 :shirt: when removing linter warnings

Pull Requests

  • Please read and use the Pull Request Template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible.