Skip to content

Commit 1e780ec

Browse files
authored
Merge pull request #828 from pkbullock/main
Added instructions file
2 parents 1140f6d + 8c246a2 commit 1e780ec

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

.github/copilot-instructions.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Script samples framework
2+
3+
## Creating a sample
4+
5+
- A sample has the following structure:
6+
- README.md
7+
- assets/sample.json
8+
- assets/preview.png
9+
- There is a template in .\scripts\\_template-script-submission
10+
11+
- The preferred way to create a sample is using PowerShell script to help users create a sample, called New-Sample.ps1 on the root of the repository. The script has the following example parameters:
12+
- Folder Name e.g. spo-get-list-items
13+
- Title e.g. Generate a list of SharePoint Sites
14+
- Description e.g. This script generates a list of SharePoint sites using the specified tool.
15+
- Tool e.g. PnPPowerShell
16+
- Author e.g. Paul Bullock
17+
- GitHub e.g. ID: pkbullock
18+
19+
- Example Script:
20+
```powershell
21+
.\New-Sample.ps1 -FolderName "spo-get-list-items" `
22+
-Title "Generate a list of SharePoint Sites" `
23+
-ShortDescription "This script generates a list of SharePoint sites using the specified tool." `
24+
-Tool PnPPowerShell `
25+
-AuthorFullName "Paul Bullock" `
26+
-GitHubId "pkbullock"
27+
```
28+
29+
- When advising the user on how to create a sample, instruct them to use the New-Sample.ps1 script, then post their PowerShell into the tabs in the Readme.md file. There are placeholders called "<your script>".
30+
31+
- If the user needs more help, there is contribution guidance here: https://pnp.github.io/script-samples/contributing/index.html

0 commit comments

Comments
 (0)