CONTRIBUTING.md

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Table of Contents

Dev Environment Pull requests

Dev Environment

• Install Visual Studio Code.

• Install Node.js, with nvm. Please use Node version 16 and npm v 8.

• Internal collaborators: Please send Aubrey Quinn your email address. After getting Write access, you can create branches and directly submit pull requests against this repo. Make and submit changes following the pull request submission workflow

• External collaborators: Fork the repo and clone your fork

• Install the dependencies

  npm install

• Add the upstream source for being able to sync main project changes back into your fork.

  git remote add upstream [email protected]:microsoft/fluentui-eslint-plugin-jsx-a11y.git

• Run the tests

  npm test

• Make and submit changes following the pull request submission workflow

To create a new ESLint rule

If you want to create a new ESLint rule:

1. create a rule file under lib/rules
2. create a doc file under docs
3. create a test file under tests
4. add your rule to lib/rules/index.ts
5. add your rule to index.ts

Pull requests

First, create a new branch

git checkout -b users/<username or alias>/bug1234

Post change, ensure to run the build command to generate the respective output file in the dist folder:

npm run build

Commit the changes to your branch, including a descriptive commit message.

git commit -m 'message describing the changes'

Before sending the pull request, make sure your code is running on the latest code from the main repo by rebasing onto the upstream source.

git fetch upstream
git rebase upstream/main
#or
git fetch upstream
git merge upstream/main

Verify your changes

npm test
npm run lint

Push your changes

git push origin users/<username or alias>/bug1234

Send the pull request, make the requested code review changes, and get merged. 2 reviewers must approve.