Skip to content

Latest commit

 

History

History
110 lines (79 loc) · 4.12 KB

CONTRIBUTING.md

File metadata and controls

110 lines (79 loc) · 4.12 KB
Raw

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:

  1. Generate the key
  2. Tell GitHub about the key
  3. Instruct Git to sign using your key

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 [email protected] 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

For all further steps yarn install is a prerequisite.

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.

Tests are in the apps directory. To execute them run yarn e2eall. Sometimes it is preferable to watch the execution and select only individual test cases. This is possible using yarn e2e-watch.

Debugging

There are several different ways to debug the dashboards:

  1. Use Chrome + React Developer Tools. The debugging experience can be a bit flaky at times, but when it works it allows you to set breakpoints and check all variables at runtime.

  2. Adding console.log(...) statements and check the console during execution. Please remember to remove the statements later on.

  3. Alternatively, you can set objects as part of window to inspect them through the console at runtime (as opposed to having to specify what to print with console.log at compile time).