5.6 KiB

Исходник Ответственный История

Contributing

Contributor license agreement

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.opensource.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., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

If you have previously committed changes that were not signed follow these steps to sign them retroactively after setting up your GPG key as described in the GitHub documentation.

Setting up a GPG key has three stages:

Note that the GitBash shell installed by Git on Windows already has GPG installed, so there is no need to install GPG separately.

Code of conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Acceptance criteria

All pull requests need to abide by the following criteria to be accepted:

passing pipelines on the GitHub pull request
signed Contributor License Agreement (CLA)
approval from at least one maintainer
compatibility with light / dark / high-contrast themes
fits with overall look-and-feel of the widget
accessibility (to be clarified)
support for localization in code (translations need not be provided)
tests for added / changed functionality

Development process

First ensure you have npm installed (which in turn may require installing node). Using npm you can install yarn as follows:

npm install -g yarn

If yarn --version succeeds you can proceed. If not, you may have to follow the instructions printed by your shell. If you're using Powershell you may have to bypass the execution policy to allow yarn to execute. One way to do this is Set-ExecutionPolicy -ExecutionPolicy Bypass.

For all further steps yarn install is a prerequisite. Run the yarn install command from your repository root directory.

To run the dashboards locally run the following from the root of the repository on your machine:

yarn start

which can take a few seconds before printing out

$ nx serve

> nx run dashboard:serve
**
Web Development Server is listening at http://localhost:4200/
**

at which point you can follow the link to your browser and select the dashboard and version of your choice.

To check for linting issues and auto-apply fixes where possible run

yarn lintfix

To build a specific app run

yarn build <app-name>  // e.g. fairness, interpret

or alternatively yarn buildall to build all of them. Since most apps have dependencies on mlchartlib it makes sense to run yarn buildall at least once.

Testing

Run e2e tests locally with mock data

git clone https://github.com/microsoft/responsible-ai-widget
cd responsible-ai-toolbox
yarn install
yarn build
To execute tests run yarn e2eall. Sometimes it is preferable to watch the execution and select only individual test cases. This is possible using yarn e2e --watch

cypress window will open locally - select test file to run the tests

Run e2e tests locally with notebook data

git clone https://github.com/microsoft/responsible-ai-widget
cd responsible-ai-toolbox (It is recommended to create a new virtual environment and install the dependencies)
yarn install
yarn buildall or yarn build widget
pip install -e responsibleai to install responsibleai locally.
pip install -e raiwidgets to install raiwidgets locally.
pip install jupyter
cd notebooks\responsibleaidashboard
To execute tests run yarn e2e-widget. Sometimes it is preferable to watch the execution and select only individual test cases. This is possible using yarn e2e-widget --watch