From 1c8e9d362864302a8c32046544f3b81210d1933b Mon Sep 17 00:00:00 2001
From: Ilya Azin <martis.azin@gmail.com>
Date: Tue, 17 Nov 2020 13:33:19 +0300
Subject: [PATCH] docs: extend new-rule doc

---
 docs/new-rule.md | 59 +++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 46 insertions(+), 13 deletions(-)

diff --git a/docs/new-rule.md b/docs/new-rule.md
index cefec44..cc6725f 100644
--- a/docs/new-rule.md
+++ b/docs/new-rule.md
@@ -1,23 +1,56 @@
-## New rule
+# Creating a new rule
 
 First of all, thank you so much for this idea and suggestion! 👍
 
 This small guide should help you to implement your own rule for `eslint-plugin-actool`
 
-1. Look at [CONTRIBUTING](../CONTRIBUTING.md) 
-2. Run [eslint rule generator](https://www.npmjs.com/package/generator-eslint#eslintrule)
-```sh
-$ npm run new:rule
+## Prerequisite
 
-? What is your name? # {YOUR_NAME}
-? Where will this rule be published? # ESLint Plugin
-? What is the rule ID? # {RULE_NAME}
-? Type a short description of this rule: # {RULE_DESCRIPTION}
-? Type a short example of the code that will fail: # (Can be ommited and specified later)
-```
+- Read [our CONTRIBUTING doc]("../CONTRIBUTING.md)
+- Read [the ESLint docs on creating a new rule.](https://eslint.org/docs/developer-guide/working-with-rules)
+- Look at the commit for how previous rules were added as inspiration. 
 
-It's all for a while)
+<!--TODO For example, the [`no-unused-properties` rule](https://github.com/sindresorhus/eslint-plugin-unicorn/commit/0179443f24326fb01342a0bf799f7ac66e0e2c23). -->
 
-If you have any questions - [official guide](https://eslint.org/docs/developer-guide/working-with-plugins) can help you, I think
+
+## Tip
+
+- Use the [**astexplorer** site](https://astexplorer.net) with the `espree` parser and `ESLint v4` transform to interactively create the initial rule implementation. It lets you inspect the full AST as you would get from ESLint and you can even see the result of your auto-fixer implementation.
+
+
+## Steps
+
+- Run [eslint rule generator](https://www.npmjs.com/package/generator-eslint#eslintrule)
+    ```sh
+    $ npm run new:rule
+
+    ? What is your name? # {YOUR_NAME}
+    ? Where will this rule be published? # ESLint Plugin
+    ? What is the rule ID? # {RULE_NAME}
+    ? Type a short description of this rule: # {RULE_DESCRIPTION}
+    ? Type a short example of the code that will fail: # (Can be ommited and specified later)
+    ```
+
+*While it's all)*
+
+
+<!--TODO
+
+- Go to the `test` directory and duplicate the `no-hex-escape.js` file and rename it to the name of your rule. Then write some tests before starting to implement the rule.
+- Go to the `rules` directory and duplicate the `no-hex-escape.js` file and rename it to the name of your rule. Then start implementing the new rule logic.
+- Add the correct [`meta.type`](https://eslint.org/docs/developer-guide/working-with-rules#rule-basics) to the rule.
+- Go to the `docs/rules` directory and duplicate the `no-hex-escape.md` file and rename it to the name of your rule. Then write some documentation.
+- Add the rule in alphabetically sorted order to:
+	- [The recommended config](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/352ba4a0291f9210ca5c8e2e61c7e3ad14028e77/index.js#L19)
+	- [The recommended config in the readme](https://github.com/sindresorhus/eslint-plugin-unicorn/blame/352ba4a0291f9210ca5c8e2e61c7e3ad14028e77/readme.md#L35)
+	- [The rule listing in the readme](https://github.com/sindresorhus/eslint-plugin-unicorn/blame/352ba4a0291f9210ca5c8e2e61c7e3ad14028e77/readme.md#L77)<br>
+	*(The description should be the same as the heading of the documentation file).*
+- Run `$ npm test` to ensure the tests pass.
+- Run `$ npm run integration` to run the rules against real projects to ensure your rule does not fail on real-world code.
+- Open a pull request with a title in exactly the format `` Add `rule-name` rule ``, for example, `` Add `no-unused-properties` rule ``.
+- The pull request description should include the issue it fixes, for example, `Fixes #123`.
+- Run `$ npm run lint` to run the rules against codebase to ensure code in the repository are following your rule, _you can ignore this step until your PR is reviewed_.
+
+-->
 
 > Happy hacking!