Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -286,18 +286,18 @@ Have a look at the existing issues. There may exist similar issues with useful i
* `examples/<your-rule>.js`
* Add some examples for the documentation
* Run the `gulp docs` task to test the examples and update the markdown documentation
* `docs/<your-rule>.js`
* `docs/<your-rule>.md`
* Generated by the `gulp docs` task

### Files you have to touch

* `index.js`
* Add your rule `rulesConfiguration.addRule('<your-rule>', [0, {someConfig: 'someValue'])`
* Add your rule `rulesConfiguration.addRule('<your-rule>', [0, {someConfig: 'someValue'}])`

### Before you open your PR

* Check that the `gulp` task is working
* Commit generated changes in `README.md` and `docs/<your-rule>.js`
* Commit generated changes in `README.md` and `docs/<your-rule>.md`
* Open your PR to the `development` branch NOT `master`

### Rules specific for Angular 1 or 2
Expand Down