Skip to content
This repository has been archived by the owner on Aug 7, 2023. It is now read-only.

Latest commit

 

History

History
42 lines (34 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

42 lines (34 loc) · 2.53 KB
Raw

Submitting Issues

  • Before creating a new issue, perform a cursory search to see if a similar issue has already been submitted.
  • You can create an issue here. Please include as many details as possible when filing an issue.
  • Issue titles should be descriptive, explaining at the high level what it is about.
  • Please include the version of linter-sass-lint being used and your Atom version
  • Please include full error messages/output when submitting issues where appropriate.

Pull Requests

  • Pull requests should reference their related issues where possible. If the pull request closes an issue, please reference its closing from a commit messages.
  • Pull request titles should be descriptive, explaining at the high level what it is doing, and should be written in the same style as Git commit messages.
  • Follow the current coding style. Your changes should pass npm run lint.
  • Ensure that EditorConfig installed in the editor and that it is functioning properly.
  • Do not squash or rebase commits when submitting a Pull Request. It makes it much harder to follow work and make incremental changes.
  • Ensure no Emoji tags are used in the title of the Pull Request

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
  • Include relevant Emoji from our Emoji cheatsheet

Emoji Cheatsheet

When creating creating commits or updating the CHANGELOG, please start the commit message or update with one of the following applicable Emoji. Emoji should not be used at the start of issue or pull request titles.

  • 🎨 :art: when improving the format/structure of the code
  • 🐎 :racehorse: when improving performance
  • 🔍 :mag: when adding a rule
  • 📝 :memo: when writing long-form text (documentation, CHANGELOG, README, etc…)
  • 🐛 :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
  • :shipit: :shipit: when creating a new release ˜