-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #54 from microsoft/users/aubreyquinn/improveDocs
added how to generate a new lint rule to the contributing.md page
- Loading branch information
Showing
1 changed file
with
26 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,31 +20,41 @@ or contact [[email protected]](mailto:[email protected]) with any addi | |
|
||
## Dev Environment | ||
|
||
* Install [Visual Studio Code](https://code.visualstudio.com/). | ||
- Install [Visual Studio Code](https://code.visualstudio.com/). | ||
|
||
* Install [Node.js](https://nodejs.org/en/), with [nvm](https://github.com/nvm-sh/nvm). | ||
- Install [Node.js](https://nodejs.org/en/), with [nvm](https://github.com/nvm-sh/nvm). | ||
|
||
* [Fork the repo and clone your fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) | ||
- [Fork the repo and clone your fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) | ||
|
||
* Install the dependencies | ||
- Install the dependencies | ||
|
||
```sh | ||
npm install | ||
``` | ||
```sh | ||
npm install | ||
``` | ||
|
||
* Add the upstream source for being able to sync main project changes back into your fork. | ||
- Add the upstream source for being able to sync main project changes back into your fork. | ||
|
||
```sh | ||
git remote add upstream [email protected]:microsoft/fluentui-eslint-plugin-jsx-a11y.git | ||
``` | ||
```sh | ||
git remote add upstream [email protected]:microsoft/fluentui-eslint-plugin-jsx-a11y.git | ||
``` | ||
|
||
* Run the tests | ||
- Run the tests | ||
|
||
```sh | ||
npm test | ||
``` | ||
```sh | ||
npm test | ||
``` | ||
|
||
* Make and submit changes following the [pull request submission workflow](#pull-requests) | ||
- Make and submit changes following the [pull request submission workflow](#pull-requests) | ||
|
||
## To create a new ESLint rule | ||
|
||
### eslint:rule | ||
|
||
If you want to create a new ESLint rule, make sure you're in the top-level directory and type: | ||
```sh | ||
yo eslint:rule | ||
``` | ||
## Pull requests | ||
|