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

Add documentation for SCSS linter and tooling to CONTRIBUTING.md #375

Closed
jglovier opened this issue Mar 17, 2016 · 2 comments
Closed

Add documentation for SCSS linter and tooling to CONTRIBUTING.md #375

jglovier opened this issue Mar 17, 2016 · 2 comments
Labels
docs issue/pull request that includes changes to documentation help wanted indicates that an issue is open for contributions

Comments

@jglovier
Copy link
Member

With the addition of the scss linter, we need to provide clear documentation about how the linter works, how to use the linter in your code editor, and how your styles should be structured to pass the linters.

@jglovier jglovier added the docs issue/pull request that includes changes to documentation label Mar 17, 2016
@tangollama tangollama added the help wanted indicates that an issue is open for contributions label Mar 17, 2016
@billybonks
Copy link
Contributor

  1. Can we assume developers know what a linter is ?
  2. Do we add documentation for atom and sublime ?
  3. Should we explain why we lint ?

We could just add links to the official documentation for some of these topics, then add docs how to setup linter on your editor.

@jglovier
Copy link
Member Author

@billybonks heh, good questions.

Can we assume developers know what a linter is?

Probably not. 😄

Do we add documentation for atom and sublime?

Yeah, that'd probably be ideal. Although I've only used the linting package on Atom myself and I don't even know that there is one for Sublime (but I'd be surprised if there wasn't).

Should we explain why we lint?

Yes, absolutely.

We could just add links to the official documentation for some of these topics, then add docs how to setup linter on your editor.

Sounds like a good strategy to me. Even if just as a first pass and then we iterate more later. 👍 ⚡

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs issue/pull request that includes changes to documentation help wanted indicates that an issue is open for contributions
Projects
None yet
Development

No branches or pull requests

3 participants