Contributing
Thank you for improving Awesome Copilot Adventures.
[!IMPORTANT] Begin with a learning outcome and observable evidence, not a feature list or fantasy story.
Contribution loop
---
config:
theme: base
look: classic
themeVariables:
darkMode: false
background: "#ffffff"
primaryColor: "#f5f5f5"
primaryTextColor: "#111111"
primaryBorderColor: "#555555"
secondaryColor: "#e0e0e0"
secondaryTextColor: "#111111"
secondaryBorderColor: "#666666"
tertiaryColor: "#bdbdbd"
tertiaryTextColor: "#111111"
tertiaryBorderColor: "#444444"
lineColor: "#444444"
textColor: "#111111"
mainBkg: "#f5f5f5"
nodeBorder: "#555555"
clusterBkg: "#ffffff"
clusterBorder: "#999999"
edgeLabelBackground: "#ffffff"
actorBkg: "#e0e0e0"
actorBorder: "#555555"
actorTextColor: "#111111"
actorLineColor: "#777777"
signalColor: "#333333"
signalTextColor: "#111111"
labelBoxBkgColor: "#f5f5f5"
labelBoxBorderColor: "#777777"
labelTextColor: "#111111"
loopTextColor: "#111111"
activationBkgColor: "#bdbdbd"
activationBorderColor: "#555555"
noteBkgColor: "#f5f5f5"
noteTextColor: "#111111"
noteBorderColor: "#777777"
attributeBackgroundColorOdd: "#f5f5f5"
attributeBackgroundColorEven: "#e0e0e0"
---
flowchart LR
accTitle: Contribution evidence gates
accDescr: A contribution moves from one learning outcome through official sources, evidence design, implementation, validation and review.
O["One learning outcome"] --> D["Official documentation"]
D --> E["Evidence and reset"]
E --> C["Adventure + lab + rubric"]
C --> V["Focused validation"]
V --> P["Reviewable pull request"]
Legend. Rectangles are contribution stages. Solid arrows show the order of reviewable work.
Explanation. Define the learning outcome and its evidence before writing the exercise. Validation and review are separate from producing the artifact.
Before writing
- Choose one primary agentic learning objective.
- Verify terminology and behavior in current official GitHub or Microsoft documentation.
- Decide which primitive is required: instructions, prompt, skill, custom agent, MCP, or hook.
- Define deterministic evidence, intentional failure, and reset steps.
- Identify stable, preview, experimental, or availability-dependent behavior.
Adventure checklist
- Create
adventures/<level>/<slug>/README.md. - Create
adventures/<level>/<slug>/rubric.md. - Add a starter under
labs/<slug>/when files or configuration change. - Add or update the deterministic verifier.
- Reference a hero asset in
assets/images/adventures/. - Add official sources and a real
last_verifieddate. - Include Ask → Plan → Agent → Review → Evidence.
- Include an intentional failure and independent challenge.
- Run
npm test. - Run the targeted language build or test when applicable.
Do not create a separate Ask-only copy. Ask is an investigation role within the same progressive adventure.
Documentation design
- Use meaningful headings and concise paragraphs.
- Use GitHub Alerts for important notes, warnings, and cautions.
- Use Mermaid when a process, dependency graph, or sequence is clearer visually.
- Keep diagrams readable without color alone.
- Include alt text for every meaningful image.
- Prefer relative links inside the repository.
- Do not place essential instructions only inside an image or video.
- Follow the monochrome diagram standard for all Mermaid blocks, including accessible titles, legends and explanations.
- Keep hands-on labs as numbered exercises, not fantasy adventures. Add a catalog entry, local fixture and audit disposition for changes.
Media
Use Media Prompts. Generated hero images should be 1456×832, contain no embedded text, and include meaningful alt text. Videos need a poster image and reduced-motion fallback.
Pull requests
Use a focused title such as New Copilot Adventure: The Skill Grimoire of Algora. Describe:
- the learning objective;
- official sources and feature status;
- files and behavioral changes;
- validation commands and results;
- limitations and follow-up media.