Skip to content

Commit

Permalink
Add contributing guideline and remove unneeded parts
Browse files Browse the repository at this point in the history
  • Loading branch information
octref committed Oct 8, 2018
1 parent 535542a commit 147c680
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 104 deletions.
3 changes: 3 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Contributing to vscode-extension-samples

If you want to contribute a new sample, see [Sample Guideline](./SAMPLE_GUIDELINE.md)
11 changes: 11 additions & 0 deletions .github/SAMPLE_GUIDELINE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Sample Guideline

Each sample should have the following components and structure, so that users could have a smooth experience when playing with the samples.

## 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.
35 changes: 17 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,28 @@
<h1 align="center">
<img alt="VS Code in action" src="https://cloud.githubusercontent.com/assets/11839736/16642200/6624dde0-43bd-11e6-8595-c81885ba0dc2.png">
<br>
<br>

VS Code Extension Samples
</h1>

This repository contains sample code illustrating the VS Code extension API. Each sample is a self-contained extension that explains one topic.

| Sample | Guide | API |
| ------ | ----- | --- |
| [Virtual Documents](/contentprovider-sample/README.md) | [https://vscode-ext-docs.azurewebsites.net/api/extension-guides/virtual-documents](/api/extension-guides/virtual-documents) | [`TextDocumentContentProvider`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#TextDocumentContentProvider) |

This repository contains sample code illustrating the VS Code extension API. The following is a
list of self-contained, running extensions that show one or multiple concepts of the API:

* [Virtual Documents](/contentprovider-sample/README.md)
* [Editor Decoration](/decorator-sample/README.md)
* [Status Bar](/statusbar-sample/README.md)
* [Theme](/theme-sample)
* [Integrated Terminal](/terminal-sample/README.md)
* [Vim](/vim-sample/README.md)
* [Tree views](/tree-view-sample/README.md)
* [Webview](/webview-sample/README.md)
- [Virtual Documents](/contentprovider-sample/README.md)
- [Editor Decoration](/decorator-sample/README.md)
- [Status Bar](/statusbar-sample/README.md)
- [Theme](/theme-sample)
- [Integrated Terminal](/terminal-sample/README.md)
- [Vim](/vim-sample/README.md)
- [Tree views](/tree-view-sample/README.md)
- [Webview](/webview-sample/README.md)

# ➡️ Getting Started

You can get started locally by following these steps:

* **Step #1**: `git clone https://github.com/Microsoft/vscode-extension-samples vscode-extension-samples`
* **Step #2**: `cd vscode-extension-samples`
* **Step #3**: `npm install`
* **Step #4**: Open [VSCode](https://code.visualstudio.com/) and start a sample from the debug viewlet.
- **Step #1**: `git clone https://github.com/Microsoft/vscode-extension-samples vscode-extension-samples`
- **Step #2**: `cd vscode-extension-samples`
- **Step #3**: `npm install`
- **Step #4**: Open [VSCode](https://code.visualstudio.com/) and start a sample from the debug viewlet.
17 changes: 4 additions & 13 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,5 @@
{
"name": "vsc-extension-samples",
"publisher": "Microsoft",
"version": "0.0.1",
"scripts": {
"postinstall": "node .build/postinstall.js",
"compile-completions": "cd completions-sample && tsc",
"compile-decorator": "cd decorator-sample && npm run compile",
"compile-previewhtml": "cd previewhtml-sample && npm run compile",
"compile-contentprovider": "cd contentprovider-sample && npm run compile",
"compile-languageprovider": "cd languageprovider-sample && npm run compile && cd ..",
"compile-statusbar": "cd statusbar-sample && npm run compile && cd .."
}
}
"name": "vsc-extension-samples",
"publisher": "Microsoft",
"version": "0.0.1"
}
73 changes: 0 additions & 73 deletions vscode-samples.code-workspace

This file was deleted.

0 comments on commit 147c680

Please sign in to comment.