Working on your first Pull Request? You can learn how from this free video series:
How to Contribute to an Open Source Project on GitHub
To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs or small features that have a relatively limited scope. This is a great place to get started.
If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don't accidentally duplicate your effort.
If somebody claims an issue but doesn't follow up for more than two weeks, it's fine to take over it but you should still leave a comment.
The core team is monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation.
Before submitting a pull request, please make sure the following is done:
Fork the repository and create your branch from the correct branch.
Run npm install
in the repository root.
For Windows 10 development environment, if you run into error gyp err! find vs msvs_version not set from command line or npm config, please install the latest Python v3 and Desktop development with C++ through Visual Studio Installer before running npm install
If you've fixed a bug or added code that should be tested, add tests!
Ensure the test suite passes (npm run test). Tip: npm test -- --watch TestName
is helpful in development.
Run npm test -- -u
to update the jest snapshots and commit these changes as well (if there are any updates).
Ensure the UI change passes npm run test-image
,Run npm run test-image -- -u
to update UI snapshots and commit these changes as well (if there are any updates), UI test base on Docker, need download the corresponding installation according to the platform
Make sure your code lints (npm run lint). Tip: Lint runs automatically when you git commit
(Use Git Hooks).
The source code of Workspace Dashboard is located at here.