Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

24 lines (17 loc) · 1.7 KB

Contributing

How you can help

The work on the plugin has just started, so if you want, you can help with any of its parts (the plugin follows Stylelint guidelines, so most of this is based on its docs):

  • Create, enhance, and debug rules (see Stylelint's guide to Working on rules).
  • Improve documentation.
  • Chime in on any open issue or pull request.
  • Open new issues about your ideas on new rules, or for how to improve the existing ones, and pull requests to show us how your idea works.
  • Add new tests to absolutely anything.
  • Work on improving performance of rules.
  • Contribute to Stylelint
  • Spread the word.

We communicate via issues and pull requests.

Links

stylelint-codeguide is a plugin for stylelint, so it adopts and uses as much of Stylelint's guidelines as it can.

  • Contributing guidelines - is a general guidelines of how to communicate with the other developers here.
  • Working on rules. stylelint-codeguide' rules are written just as Stylelint's rules, except that all rules need to be namespaced using the namespace utility function.
  • Testing rules | Running tests. Always provide as many tests as you can.