microsoft/vscode-react-native
Publicmirrored fromhttps://github.com/microsoft/vscode-react-nativeAvailable
.github/CONTRIBUTING.md
57lines · modecode
| 1 | ## Development setup |
| 2 | We welcome any quality bugfixes or contributions! |
| 3 | |
| 4 | To avoid a conflict, delete the installed extension at `~/.vscode/extensions/vsmobile.vscode-react-native`. |
| 5 | |
| 6 | ### Windows |
| 7 | * In `C:/Users/<username>/.vscode/extensions/`, `git clone` this repository |
| 8 | |
| 9 | ### OS X/Linux |
| 10 | * `git clone` this repository |
| 11 | * Run `ln -s <path to repo> ~/.vscode/extensions/vscode-react-native` |
| 12 | * You could clone it to the extensions directory if you want, but working with hidden folders in OS X can be a pain. |
| 13 | |
| 14 | ### Then... |
| 15 | * `cd` to the folder you just cloned |
| 16 | * Run `npm install -g gulp` and `npm install` |
| 17 | * You may see an error if `bufferutil` or `utf-8-validate` fail to build. These native modules required by `ws` are optional and the debug adapter should work fine without them. |
| 18 | * Run `gulp build` |
| 19 | |
| 20 | |
| 21 | ##Debugging |
| 22 | There are currently 3 components to our extension: The extension running in the vscode process, 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: |
| 23 | |
| 24 | * To debug the extension process itself, 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. |
| 25 | |
| 26 | * 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. |
| 27 | |
| 28 | * Currently the codebase is not configured for easy debugging of the debug adapter, and we plan significant changes in the near future. However, if you ensure that `out/debugger/nodeDebugLocation.json` contains a `nodeDebugPath` entry which points to the location of the node debug adapter extension (Run the extension normally and open up a react-native project to generate this file), then you can run `node --harmony --server=4712 out/debugger/nodeDebugWrapper.js` to start a standalone instance of the debug adapter (optionally with a debugger attached to it) and then inside a react-native project add `"debugServer": 4712` to the top-level launch.json to get it to use the standalone instance. |
| 29 | |
| 30 | |
| 31 | ## Testing |
| 32 | There is a set of mocha tests for the debug adapter which can be run with `npm test`, and a set of mocha tests for the other functionality run as part of the `test` launch config. Also run `gulp tslint` to check your code against our tslint rules. |
| 33 | |
| 34 | See the project under test/testProjcet/ for a sample project that should build and compile, allow debugging of plugins and merges, and enable intellisense for plugins. |
| 35 | |
| 36 | ## Legal |
| 37 | |
| 38 | You will need to 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. |
| 39 | |
| 40 | Please submit a Contributor License Agreement (CLA) before submitting a pull request. You may visit https://cla.microsoft.com to sign digitally. Alternatively, download the agreement ([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 the agreement. Once we have received the signed CLA, we'll review the request. |
| 41 | |
| 42 | ## Sending PR |
| 43 | |
| 44 | Your pull request should: |
| 45 | |
| 46 | * Include a clear description of the change |
| 47 | * Be a child commit of a reasonably recent commit in the **master** branch |
| 48 | * Requests need not be a single commit, but should be a linear sequence of commits (i.e. no merge commits in your PR) |
| 49 | * It is desirable, but not necessary, for the tests to pass at each commit |
| 50 | * Have clear commit messages |
| 51 | * e.g. "Refactor feature", "Fix issue", "Add tests for issue" |
| 52 | * Include adequate tests |
| 53 | * 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 |
| 54 | * Tests should include reasonable permutations of the target fix/change |
| 55 | * Include baseline changes with your change |
| 56 | * Ensure there are no linting issues ("gulp tslint") |
| 57 | * To avoid line ending issues, set `autocrlf = input` and `whitespace = cr-at-eol` in your git configuration |
| 58 | |