Skip to content

Commit f6f7313

Browse files
authored
Merge pull request #2059 from PowerShell/SnippetReq
Documents Snippet Requirements
2 parents 7ac90a1 + e6235d7 commit f6f7313

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

docs/community_snippets.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,14 @@ Add the Send-MailMessage cmdlet with the most common parameters in a hashtable f
398398

399399
## Contributing
400400

401-
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:
401+
To optimize snippet usability and discoverability for end users we will only ship snippets in the extension which we believe meet the following requirements:
402+
- Must be broadly applicable to most PowerShell extension users
403+
- Must be substantially different from existing snippets or intellisense
404+
- Must not violate any intellectual property rights
405+
406+
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).
407+
408+
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:
402409

403410
### Table of contents
404411

docs/development.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,8 @@ When you build, this will:
5555
- 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
5656
- Adds "Preview" in a few places in the package.json
5757

58-
This mechanism is mostly used for releases.
58+
This mechanism is mostly used for releases
59+
60+
## Contributing Snippets
61+
62+
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 commit comments

Comments
 (0)