doc: rework public-facing onboarding documentation#2811
Open
JasonYeMSFT wants to merge 3 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reworks the repo’s public-facing contributor onboarding by moving detailed “how to contribute skills” guidance out of CONTRIBUTING.md into a dedicated docs/Onboarding.md, leaving CONTRIBUTING.md slimmer and more focused.
Changes:
- Added a new
docs/Onboarding.mdwith end-to-end onboarding guidance for contributing new/extended skills. - Removed most onboarding/how-to content from
CONTRIBUTING.md, keeping it focused on bug/feature reporting and a pointer to the onboarding doc.
Show a summary per file
| File | Description |
|---|---|
| docs/Onboarding.md | New detailed onboarding guide for skill contributions (local dev, structure, token management, testing). |
| CONTRIBUTING.md | Simplified contributing doc; now points skill contributors to the new onboarding guide. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 3
- Review effort level: Low
yunjchoi
reviewed
Jul 13, 2026
|
|
||
| Skills should be concise and focused prompts that help with a specific task. The LLM sees the descriptions of the skills and decides which one to load based on the user's intent. They can be treated as additional user prompts. | ||
|
|
||
| A good skill has the following characteristics: |
Collaborator
There was a problem hiding this comment.
Is there an existing skill that we can point people to that demonstrates the following characteristics?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Reworks the public-facing onboarding documentation. Slims down CONTRIBUTING.md significantly and moves the detailed onboarding content into a new dedicated docs/Onboarding.md file.
Key changes:
Checklist
cd tests && npm test)fix:,feat:,feature:,chore:,misc:,test:,eval:tests/,npm run test:integration -- <skill>ornpm run test:vally -- --skill <skill>)Related Issues