You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -6,8 +6,8 @@ Thank you for your interest in contributing.
6
6
7
7
Depending on your needs, you may have one of two development paths:
8
8
9
-
- via integrating with an existing usage (ideal for modifying the interface of our rules)
10
-
- via unit testing (ideal for adding a new rule)
9
+
* via integrating with an existing usage (ideal for modifying the interface of our rules)
10
+
* via unit testing (ideal for adding a new rule)
11
11
12
12
For that reason we've included two paths to develop. Feel free to use either, or both.
13
13
@@ -32,8 +32,8 @@ It may be useful to work on this in tandem with a codebase that uses the rules.
32
32
If you go to the `node_modules` directory in your codebase and try to navigate into the package, you'll notice that whatever changes you make in your local development directory will be reflected in the codebase.
33
33
34
34
3. Reset symlinks at any time by reversing the steps via `npm unlink`.
35
-
- in your codebase: `npm unlink @github/markdownlint-github`
36
-
- in this directory: `npm unlink`
35
+
* in your codebase: `npm unlink @github/markdownlint-github`
See [`markdownlint` rules](https://github.com/DavidAnson/markdownlint#rules--aliases) for documentation on rules pulled in from `markdownlint`.
19
19
@@ -29,11 +29,11 @@ See [`markdownlint` rules](https://github.com/DavidAnson/markdownlint#rules--ali
29
29
30
30
2. Install packages.
31
31
32
-
- ```bash
33
-
npm install -D markdownlint-cli2 # if updating existing package, check for updates
0 commit comments