Ready to share a script or an improvement? You do not need a perfect first draft. Open a focused pull request, explain what you tested, and work with maintainers on the finishing touches.
1. Work in your fork
Fork the repository, clone your fork, and create a branch for your change. If you have not prepared the sample yet, follow the generator and preparation guide.
For an existing fork, use GitHub's Sync fork option before starting new work. Keep changes to one scenario or improvement together; put unrelated work in another pull request.
Need a hand with GitHub? Sharing is caring offers hands-on sessions for first-time contributors.
2. Commit and push your branch
Review the changed files in your editor. Include the sample README, metadata, images, and related guidance. Remove credentials, private tenant details, and unrelated generated files.
Commit with a short message describing the contribution, then push the branch to your fork. In GitHub, choose Compare & pull request and target the main branch of pnp/script-samples.
3. Tell reviewers what changed
Use a descriptive title such as New sample: export a SharePoint site inventory.
In the description, include:
- The scenario and who it helps.
- The tool or tools you used and their tested versions.
- How you tested the script and the expected result, without private tenant details.
- Any permissions, destructive actions, limitations, or questions reviewers should know about.
- A link to a related issue, if you have one.
You can open a draft pull request if you want early feedback. Push further commits to the same branch to update the pull request; you do not need to create a new one.
4. Complete the contribution agreement and review
If asked, follow the pull request's instructions to sign the Microsoft Contributor License Agreement. This is normally a one-time step for contributions covered by that agreement.
Maintainers will review the contribution and may ask for changes or clarification. Respond in the pull request, update the same branch, and ask if a comment is unclear. Keep your branch until the pull request is merged or closed.
If a check fails, read its output and address the files it identifies. Ask for help rather than making unrelated changes just to get a check to pass.
5. Celebrate and share the published sample
After the pull request is merged, the automated site build publishes it to the gallery. Publication depends on a successful build; it may not be immediate.
Open the published sample to confirm its content and images. Then share the gallery link, credit coauthors, and describe the problem it solves. You can also request a community demo slot.
Every sample contributor is eligible for the Script Samples contributor badge after their first accepted sample. Opt in to the recognition program and follow its badge-claim instructions.
Thank you for sharing your time and experience. This repository is maintained by volunteers, so review times vary. If you are unsure what to do next, leave a comment on your pull request or open an issue.
Preparation checklist | Contributor recognition | Community calls
