Skip to content

Commit

Permalink
Merge pull request #54 from microsoft/users/aubreyquinn/improveDocs
Browse files Browse the repository at this point in the history
added how to generate a new lint rule to the contributing.md page
  • Loading branch information
aubreyquinn authored Mar 12, 2024
2 parents 113e5dd + 184b936 commit 7a6d74a
Showing 1 changed file with 26 additions and 16 deletions.
42 changes: 26 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 7a6d74a

Please sign in to comment.