Skip to content

Commit 4d5cd8d

Browse files
committed
Add doc about file name for rules
1 parent b85e09a commit 4d5cd8d

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ All contributions should be pushed in the current GIT branch.
9999
## How to create a new rule
100100
Here are the things you should do before sending a Pull Request with a new Rule :
101101

102-
* Create a JavaScript file for the new rule in the rules directory
103-
* Create an unit test for this rule in the test directory
102+
* Create a JavaScript file for the new rule in the rules directory (the name of the file should be prefixed by 'ng' for Angular 1 rules, or 'ng2' for Angular 2 rules)
103+
* Create an unit test for this rule in the test directory (with the same name)
104104
* Update the main index.js file, in order to add the new rule in the 'rules' property, and set the default configuration in the rulesConfig property
105105
* Update the "Rules" part of the README.md file with a small description of the rule and its default configuration.
106106

0 commit comments

Comments
 (0)