Skip to content

doc: rework public-facing onboarding documentation#2811

Open
JasonYeMSFT wants to merge 3 commits into
microsoft:mainfrom
JasonYeMSFT:chuye/onboarding-doc
Open

doc: rework public-facing onboarding documentation#2811
JasonYeMSFT wants to merge 3 commits into
microsoft:mainfrom
JasonYeMSFT:chuye/onboarding-doc

Conversation

@JasonYeMSFT

@JasonYeMSFT JasonYeMSFT commented Jul 9, 2026

Copy link
Copy Markdown
Member

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:

  1. Documented high level requirements for skills to have clear objective, maximize determinism, respect context window and improve agent outcome. We can refer to these requirements when evaluating future onboarding requests.
  2. Documented the requirement to fill onboarding request before submitting PRs. We should enforce this by not reviewing PRs before a proper onboarding issue has been created.
  3. Documented the requirement to have integration tests; added reference to vally-eval skill as documentation on how to create integration tests
  4. Cleaned up stale instructions, such as information that is no longer correct, the old token limit due to not being realistic and basic git instructions that contributors should have already known

Checklist

  • Tests pass locally (cd tests && npm test)
  • Title has one of the prefixes: fix:, feat:, feature:, chore:, misc:, test:, eval:
  • If modifying skill descriptions: verified routing correctness with integration tests (In tests/, npm run test:integration -- <skill> or npm run test:vally -- --skill <skill>)

Related Issues

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md with 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

Comment thread docs/Onboarding.md
Comment thread docs/Onboarding.md
Comment thread docs/Onboarding.md
@JasonYeMSFT JasonYeMSFT marked this pull request as ready for review July 9, 2026 23:12
@JasonYeMSFT JasonYeMSFT changed the title misc: rework public-facing onboarding documentation doc: rework public-facing onboarding documentation Jul 9, 2026
Comment thread docs/Onboarding.md Outdated
Comment thread docs/Onboarding.md

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:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there an existing skill that we can point people to that demonstrates the following characteristics?

Comment thread docs/Onboarding.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants