-
Notifications
You must be signed in to change notification settings - Fork 483
Developer Guide
This guide is intended for those who wish to:
- Contribute code to CSS Lint
- Create their own rules for CSS Lint
- Customize a build of CSS Lint
In order to work with CSS Lint as a developer, it's recommended that:
- You know JavaScript, since CSS Lint is written in JavaScript.
- You're comfortable with command-line programs.
- You understand unit tests and why they're important.
If that sounds like you, then continue reading to get started.
Section 1: Get the Source Code
Before you can get started, you'll need to get a copy of the CSS Lint source code. This section explains how to do that and a little about the source code structure.
Section 2: Learn the Build System
CSS Lint uses a build system to make maintaining and testing the code easier. You'll need to learn the build system in order to verify your changes work.
Section 3: Run the Unit Tests
There are a lot of unit tests included with CSS Lint to make sure that we're keeping on top of code quality. This section explains how to run the unit tests.
Section 4: Working with Rules
You're finally ready to start working with rules. You may want to fix an existing rule or create a new one. This section explains how to do all of that.
Section 5: Contributing
Once you've made changes that you want to share with the community, the next step is to submit those changes back via a pull request.