Skip to content

Commit

Permalink
Merge pull request #2059 from PowerShell/SnippetReq
Browse files Browse the repository at this point in the history
Documents Snippet Requirements
  • Loading branch information
SydneyhSmith authored Jul 1, 2019
2 parents 7ac90a1 + e6235d7 commit f6f7313
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
9 changes: 8 additions & 1 deletion docs/community_snippets.md
Original file line number Diff line number Diff line change
Expand Up @@ -398,7 +398,14 @@ Add the Send-MailMessage cmdlet with the most common parameters in a hashtable f

## Contributing

If you'd like to add a snippet to this list, [open a pull request](https://opensource.guide/how-to-contribute/#opening-a-pull-request) with the following changes:
To optimize snippet usability and discoverability for end users we will only ship snippets in the extension which we believe meet the following requirements:
- Must be broadly applicable to most PowerShell extension users
- Must be substantially different from existing snippets or intellisense
- Must not violate any intellectual property rights

If your snippet does not meet these requirements but would still be useful to customers we will include it in our list of [Awesome Community Snippets](https://github.com/PowerShell/vscode-powershell/blob/master/docs/community_snippets.md). Additionally, snippet creators can publish snippet libraries as standalone extensions in the [VSCode Marketplace](https://code.visualstudio.com/api/working-with-extensions/publishing-extension).

If you'd like a snippet to be considered for addition to the list, [open a pull request](https://opensource.guide/how-to-contribute/#opening-a-pull-request) with the following changes:

### Table of contents

Expand Down
6 changes: 5 additions & 1 deletion docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,8 @@ When you build, this will:
- Add a warning to the top of the README.md to warn users not to have the stable and preview version enabled at the same time
- Adds "Preview" in a few places in the package.json

This mechanism is mostly used for releases.
This mechanism is mostly used for releases

## Contributing Snippets

For more information on contributing snippets please read our [snippet requirements](https://github.com/PowerShell/vscode-powershell/blob/master/docs/community_snippets.md#contributing).

0 comments on commit f6f7313

Please sign in to comment.