|
2 | 2 | <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> |
3 | 3 | # Contributing |
4 | 4 |
|
| 5 | +- [Pull Requests](#pull-requests) |
5 | 6 | - [Requirements](#requirements) |
6 | 7 | - [Development Workflow](#development-workflow) |
7 | 8 | - [Build](#build) |
|
12 | 13 |
|
13 | 14 | - [Detailed CI and build process docs](../ci) |
14 | 15 |
|
| 16 | +## Pull Requests |
| 17 | + |
| 18 | +Please link to the issue each PR solves. |
| 19 | +If there is no existing issue, please first create one unless the fix is minor. |
| 20 | + |
| 21 | +Please make sure the base of your PR is the master branch. We keep the GitHub |
| 22 | +default branch the latest release branch to avoid confusion as the |
| 23 | +documentation is on GitHub and we don't want users to see docs on unreleased |
| 24 | +features. |
| 25 | + |
15 | 26 | ## Requirements |
16 | 27 |
|
17 | 28 | Please refer to [VS Code's prerequisites](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites). |
@@ -49,26 +60,45 @@ reset VS Code then run `yarn vscode:patch`. |
49 | 60 |
|
50 | 61 | ## Build |
51 | 62 |
|
| 63 | +You can build with: |
| 64 | + |
| 65 | +```shell |
| 66 | +./ci/steps/release.sh |
| 67 | +``` |
| 68 | + |
| 69 | +Run your build with: |
| 70 | + |
| 71 | +``` |
| 72 | +cd release |
| 73 | +yarn --production |
| 74 | +# Runs the built JavaScript with Node. |
| 75 | +node . |
| 76 | +``` |
| 77 | + |
| 78 | +Build release packages (make sure you run `./ci/steps/release.sh` first): |
| 79 | + |
| 80 | +``` |
| 81 | +./ci/steps/release-packages.sh |
| 82 | +# The standalone release is in ./release-standalone |
| 83 | +# .deb, .rpm and the standalone archive are in ./release-packages |
| 84 | +``` |
| 85 | + |
| 86 | +The `release.sh` script is the equivalent of: |
| 87 | + |
52 | 88 | ```shell |
53 | 89 | yarn |
54 | 90 | yarn vscode |
55 | 91 | yarn build |
56 | 92 | yarn build:vscode |
57 | 93 | yarn release |
58 | | -cd release |
59 | | -yarn --production |
60 | | -# Runs the built JavaScript with Node. |
61 | | -node . |
62 | 94 | ``` |
63 | 95 |
|
64 | | -Now you can build release packages with: |
| 96 | +And `release-packages.sh` is: |
65 | 97 |
|
66 | 98 | ``` |
67 | 99 | yarn release:standalone |
68 | | -# The standalone release is in ./release-standalone |
69 | 100 | yarn test:standalone-release |
70 | 101 | yarn package |
71 | | -# .deb, .rpm and the standalone archive are in ./release-packages |
72 | 102 | ``` |
73 | 103 |
|
74 | 104 | ## Structure |
|
0 commit comments