bingyi/vscode-extension-samples
1
0
Fork 0
mirror of https://github.com/microsoft/vscode-extension-samples.git synced 2026-04-27 16:55:44 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update sample guideline

Browse Source
This commit is contained in:
Pine Wu
2018-10-09 11:39:48 -07:00
parent 154ad38e3f
commit 27dff9b115
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
.github/SAMPLE_GUIDELINE.md vendored
View File

@ -2,10 +2,10 @@
Each sample should have the following components and structure, so that users could have a smooth experience when playing with the samples.
## README
## 1: README
- Each README should start with a short sentence / paragraph that describes what the extensions is and what it is meant to illustrate.
- If the sample has a corresponding guide, it should link to the guide.
- If the illustrated functionality is visual, a gif/image should follow the explanation.
- A `Running the sample` section should describe the actions to run the sample.
- Mostly, it should be: Open this sample in VS Code -> `npm install && npm compile` -> Run `Launch Sample` target.
- 1.1: Each README should start with a short sentence / paragraph that describes what the extensions is and what it is meant to illustrate.
- 1.2: If the sample has a corresponding guide, it should link to the guide.
- 1.3: If the illustrated functionality is visual, a gif/image should follow the explanation. (File should be demo.png/gif/jpg. Use Dark+ theme)
- 1.4: A `Running the sample` section should describe the actions to run the sample.
- 1.4.1: Mostly, it should be: Open this sample in VS Code -> `npm install && npm compile` -> Run `Launch Sample` target.