Skip to content

Commit 23ea426

Browse files
citkaneGerrit0
authored andcommitted
Document correct command to fix linting errors.
The --fix flag causes: - [warn] Ignored unknown option --fix. use --write for the correct behavior. *note: --write has re-formatted 'CONTRIBUTING.md' as per this pull request.
1 parent 94f6693 commit 23ea426

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

.github/CONTRIBUTING.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,21 @@ This document includes a set of guidelines for contributing to TypeDoc. These ar
66

77
## Table of Contents
88

9-
1. [How Can I Contribute?](#how-can-i-contribute)
10-
- [Bug Reports](#bug-reports)
11-
- [Suggestions](#suggestions)
12-
- [Documentation](#documentation)
13-
- [Code](#code)
14-
1. [Setup - Git, GitHub, and Node](#setup---git-github-and-node)
15-
1. [Linting, Building, and Testing](#linting-building-and-testing)
16-
1. [Pull Requests](#pull-requests)
17-
1. [Updating Your Branch](#updating-your-branch)
9+
- [Contributing to TypeDoc](#contributing-to-typedoc)
10+
- [Table of Contents](#table-of-contents)
11+
- [How Can I Contribute?](#how-can-i-contribute)
12+
- [Bug Reports](#bug-reports)
13+
- [Suggestions](#suggestions)
14+
- [Documentation](#documentation)
15+
- [Code](#code)
16+
- [Setup - Git, GitHub, and Node](#setup---git-github-and-node)
17+
- [Installation](#installation)
18+
- [Linting, Building, and Testing](#linting-building-and-testing)
19+
- [Linting](#linting)
20+
- [Building](#building)
21+
- [Testing](#testing)
22+
- [Pull Requests](#pull-requests)
23+
- [Updating Your Branch](#updating-your-branch)
1824

1925
## How Can I Contribute?
2026

@@ -102,7 +108,7 @@ Once you have cloned TypeDoc, you can lint, build, and test the code from your t
102108
103109
To lint the TypeDoc code, run `npm run lint`. This will start eslint and check all files for stylistic problems. You can also install an eslint plugin for your editor to show most style problems as you type.
104110
105-
You can automatically fix some style problems by running `npm run lint -- --fix`.
111+
You can automatically fix some style problems by running `npm run lint -- --write`.
106112
107113
#### Building
108114

0 commit comments

Comments
 (0)