microsoft/vscode-react-native
Publicmirrored from https://github.com/microsoft/vscode-react-nativeAvailable
CONTRIBUTING.md
56lines · modecode
| 1 | ## Development setup |
| 2 | |
| 3 | We welcome any quality bugfixes or contributions! |
| 4 | |
| 5 | To avoid conflicts with your existing installation, it is recommended to delete the installed extension at: |
| 6 | |
| 7 | - **Linux and macOS**: `~/.vscode/extensions/msjsdiag.vscode-react-native-<version>` |
| 8 | - **Windows**: `C:\Users\<username>\.vscode\extensions\msjsdiag.vscode-react-native-<version>` |
| 9 | |
| 10 | ### Clone the repository |
| 11 | |
| 12 | - `git clone https://github.com/microsoft/vscode-react-native.git` to any preferrable folder |
| 13 | - `cd` to the folder you just cloned |
| 14 | - Run `npm install -g gulp` and `npm ci` |
| 15 | - Run `gulp` |
| 16 | |
| 17 | ## Debugging |
| 18 | |
| 19 | There are currently 2 components to our extension: The extension running in the VS Code process with the debug adapter, and some code wrapping the user React Native code which is launched by the debug adapter. These are all debugged in different ways: |
| 20 | |
| 21 | - To debug the extension process itself and the debug adapter it provides, in VS Code run the `Launch Extension` debug target which will spawn a new instance of VS Code with the extension installed. You can set breakpoints in the Typescript and debug things such as extension activation and the command palette. |
| 22 | |
| 23 | - To debug the code running in the same process as the React Native code, open up an instance of VS Code running the extension on a React Native project. From this instance, open up the Typescript file in the extension codebase that you wish to debug and add breakpoints. Now, when you launch the React Native project, you should hit breakpoints in the extension code wrapper. |
| 24 | |
| 25 | - In addition you can also debug the functional indirectly by debugging the `debuggerWorker.js` file which is generated by Metro bundler, but modified by extension and saved in your React Native `.vscode/.react` folder locally. This file is created only when you start debugging against your React Native application and the debugger is already attached to it. The `debuggerWorker.js` is launched in `--inspect-brk` mode so it will wait until debugger is attached to the app. |
| 26 | |
| 27 | ## Testing |
| 28 | |
| 29 | There is a set of Mocha tests for the extesnion and extension localization which can be run with `npm test` and `npm test-localization` or by `Launch Extension Tests` and `Launch Localization Tests`. Also there are e2e smoke tests placed in [`test/smoke`](https://github.com/microsoft/vscode-react-native/tree/master/test/smoke) folder that can be launched by `npm smoke-tests` command or by `Launch All Smoke Tests` command. Make sure to [prepare test environment](https://github.com/microsoft/vscode-react-native/blob/master/test/smoke/docs/run-locally.md) before launching e2e tests. |
| 30 | |
| 31 | Run `gulp lint` to check your code against our linting rules or `gulp format` to try to autofix all linting problems with Prettier. |
| 32 | |
| 33 | ## Legal |
| 34 | |
| 35 | You must complete a Contributor License Agreement (CLA). Briefly, this agreement testifies that you are granting us permission to use the submitted change according to the terms of the project's license, and that the work being submitted is under appropriate copyright. |
| 36 | |
| 37 | Please submit a Contributor License Agreement (CLA) before submitting a pull request. You may visit [https://cla.microsoft.com](https://cla.microsoft.com) to sign the agreement digitally. Alternatively, download the agreement from ([Microsoft Contribution License Agreement.docx](https://www.codeplex.com/Download?ProjectName=typescript&DownloadId=822190) or [Microsoft Contribution License Agreement.pdf](https://www.codeplex.com/Download?ProjectName=typescript&DownloadId=921298)), sign, scan, and email it back to <cla@microsoft.com>. Be sure to include your github user name along with a copy of the signed agreement. Once we have received the signed CLA, we'll review the request. |
| 38 | |
| 39 | ## Sending a PR |
| 40 | |
| 41 | Pull requests should: |
| 42 | |
| 43 | - Include a clear description of the proposed change |
| 44 | - Be a child commit of a reasonably recent commit in the **master** branch |
| 45 | - Requests need not be a single commit, but should be a linear sequence of commits (i.e. no merge commits in your PR) |
| 46 | - Have clear commit messages |
| 47 | - e.g. "Refactor feature", "Fix issue", "Add tests for issue" |
| 48 | - Include adequate tests |
| 49 | - At least one test should fail in the absence of your non-test code changes. If your PR does not match this criteria, please specify why |
| 50 | - Tests should include reasonable permutations of the target fix/change |
| 51 | - Include baseline changes with your change |
| 52 | - Have linting issues (`gulp lint`) |
| 53 | |
| 54 | It is desirable, but not necessary, for the tests to pass at each commit. |
| 55 | |
| 56 | To avoid line ending issues, set `autocrlf = input` and `whitespace = cr-at-eol` in your system's git configuration. |
| 57 | |