From 5445fba50d867ee4c6dda004b2aacadd63aa2da1 Mon Sep 17 00:00:00 2001 From: Neo Tan Date: Wed, 22 Sep 2021 12:15:43 +0800 Subject: [PATCH] docs: setup development environment for windows (#32230) --- docs/react/contributing.en-US.md | 1 + docs/react/contributing.zh-CN.md | 13 +++++++------ 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/react/contributing.en-US.md b/docs/react/contributing.en-US.md index f89a5f5d64..4f9000e0e3 100644 --- a/docs/react/contributing.en-US.md +++ b/docs/react/contributing.en-US.md @@ -50,6 +50,7 @@ The core team is monitoring for pull requests. We will review your pull request 1. Fork the repository and create your branch from the [correct branch](#Branch-Organization). 1. 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](https://www.python.org/downloads/) and **Desktop development with C++** through [Visual Studio Installer](https://docs.microsoft.com/en-us/visualstudio/install/install-visual-studio?view=vs-2019#step-3---install-the-visual-studio-installer) before running `npm install` 1. If you've fixed a bug or added code that should be tested, add tests! 1. Ensure the test suite passes (npm run test). Tip: `npm test -- --watch TestName` is helpful in development. 1. Run `npm test -- -u` to update the [jest snapshots](http://facebook.github.io/jest/docs/en/snapshot-testing.html#snapshot-testing-with-jest) and commit these changes as well (if there are any updates). diff --git a/docs/react/contributing.zh-CN.md b/docs/react/contributing.zh-CN.md index 95e986e80c..33cdd9c2f0 100644 --- a/docs/react/contributing.zh-CN.md +++ b/docs/react/contributing.zh-CN.md @@ -49,12 +49,13 @@ Ant Design 团队会关注所有的 pull request,我们会 review 以及合并 **在你发送 Pull Request 之前**,请确认你是按照下面的步骤来做的: 1. 基于 [正确的分支](#分支管理) 做修改。 -2. 在项目根目录下运行了 `npm install`。 -3. 如果你修复了一个 bug 或者新增了一个功能,请确保写了相应的测试,这很重要。 -4. 确认所有的测试都是通过的 `npm run test`。 小贴士:开发过程中可以用 `npm test -- --watch TestName` 来运行指定的测试。 -5. 运行 `npm test -- -u` 来更新 [jest snapshot](http://facebook.github.io/jest/docs/en/snapshot-testing.html#snapshot-testing-with-jest) 并且把这些更新也提交上来(如果有的话)。 -6. 确认所有的 UI 改动通过 `npm run test-image`,可以运行 `npm run test-image -- -u` 更新 UI 快照并且把这些更新也提交上来(如果有的话),**UI 测试基于 [Docker](https://docs.docker.com/get-docker/),根据平台下载对应的安装程序。** -7. 确保你的代码通过了 lint 检查 `npm run lint`. 小贴士: Lint 会在你 `git commit` 的时候自动运行(通过[Git Hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks))。 +1. 在项目根目录下运行了 `npm install`。 + > 在 Windows 10 开发环境下,如果出现 `gyp err! find vs msvs_version not set from command line or npm config`错误, 请在运行 `npm install` 前安装 [最新版 Python v3](https://www.python.org/downloads/), 并通过 [Visual Studio Installer](https://docs.microsoft.com/en-us/visualstudio/install/install-visual-studio?view=vs-2019#step-3---install-the-visual-studio-installer) 安装 **Desktop development with C++**。 +1. 如果你修复了一个 bug 或者新增了一个功能,请确保写了相应的测试,这很重要。 +1. 确认所有的测试都是通过的 `npm run test`。 小贴士:开发过程中可以用 `npm test -- --watch TestName` 来运行指定的测试。 +1. 运行 `npm test -- -u` 来更新 [jest snapshot](http://facebook.github.io/jest/docs/en/snapshot-testing.html#snapshot-testing-with-jest) 并且把这些更新也提交上来(如果有的话)。 +1. 确认所有的 UI 改动通过 `npm run test-image`,可以运行 `npm run test-image -- -u` 更新 UI 快照并且把这些更新也提交上来(如果有的话),**UI 测试基于 [Docker](https://docs.docker.com/get-docker/),根据平台下载对应的安装程序。** +1. 确保你的代码通过了 lint 检查 `npm run lint`. 小贴士: Lint 会在你 `git commit` 的时候自动运行(通过[Git Hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks))。 给 [react-component](https://github.com/react-component/) 发送 pull request: