PowerShell / PowerShell/vscode-powershell

Include Snippet Best Practices in Snippets Doc

Open
#1,311 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area-Documentation Issue-Discussion
Dominant language
TypeScript
Stars
1.9k
Forks
547
PR merge metrics
No merged PRs in 30d

Description

I've been talking with @fatherjack who has an AWESOME list of snippets already:
https://github.com/fatherjack/vscode-snippets

He has a few best practices and I thought that since we have the data, we could also do some light enforcing of best practices.

So with that said, bring your opinions and let's see what you have to say 😁

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file or test is named. Start by locating the snippets documentation and reviewing the linked vscode-snippets list; the work is only done once the best practices and any enforcement scope are agreed and documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript, vscode
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.