Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
127 lines (83 loc) · 4.31 KB

CONTRIBUTING.md

File metadata and controls

127 lines (83 loc) · 4.31 KB
Raw

Contributing to copilot-learning-labs

Thank you for your interest in improving this course. All contributions — content fixes, new labs, improved prompts, updated examples, translation notes — are welcome.

Ways to Contribute

Type Description
Content fix Correct outdated information, broken links, or errors
Clarification Improve explanations, add missing context
New guided example Add a guided prompt example to a module, following the module template
Prompt improvement Refine or add to the prompt library
Agent definition Add or improve an agent persona
Translation Translate a module into another language
Typo / formatting Fix spelling, grammar, or markdown formatting

Before You Start

  1. Search existing issues and PRs — your idea may already be in progress.
  2. Open an issue first for significant changes (new modules, restructuring, template changes). Use the appropriate issue template.
  3. For small fixes (typos, broken links, outdated dates), a direct PR is fine — no issue needed.

How to Contribute

1. Fork and clone

git clone https://github.com/YOUR_USERNAME/copilot-learning-labs.git
cd copilot-learning-labs

2. Create a branch

Use a descriptive branch name:

git checkout -b fix/module-01-typos
git checkout -b feat/module-09-guided-example
git checkout -b update/prompt-debugging-null-handling

3. Make your changes

Follow the conventions below and use the templates in /templates.

4. Open a pull request

Use the PR template. Include:

  • What changed and why
  • Which module, lab, or asset is affected
  • Whether any links or cross-references were updated

Content Conventions

Markdown

  • Use ATX headings (#, ##, ###) — no underline style.
  • Put one blank line before and after headings, lists, and code blocks.
  • Wrap code samples in fenced code blocks with a language hint (```python).
  • Keep lines under 120 characters where practical.

Modules

  • Follow templates/module-readme-template.md exactly. A module is exactly two files: README.md + summary.md.
  • Always include the Verified: YYYY-MM date in the module header.
  • Always include the ⚠️ AI Credit note callout.
  • Guided prompt examples follow the fixed shape: The prompt → Expected output → What to observe. Link matching prompts/ entries instead of duplicating them.
  • Do not add exercises or tasks for the learner to complete — hands-on work lives in capstone/.

Module summaries

Prompts

  • Follow templates/prompt-template.md.
  • Include at least one realistic example with actual input and expected output.
  • State whether a frontier model is recommended.

Agents

Feature Verification

If you update content that references a specific GitHub Copilot feature:

  • Verify against the official documentation before publishing.
  • Update the Verified: YYYY-MM field in the module or file header.
  • Note any plan-specific restrictions (Pro vs. Pro+ vs. Business vs. Enterprise).

What Not to Do

  • Do not add speculative features ("this will soon support…").
  • Do not reproduce copyrighted third-party content.
  • Do not commit secrets, credentials, or personal data — even in example files.
  • Do not change the template structure without opening an issue first. Templates affect all future content.

Community

  • Use GitHub Discussions for questions, ideas, and learning support.
  • Use Issues for actionable content problems and feature requests.
  • Be constructive, specific, and evidence-based in all feedback.
  • Follow the CODE_OF_CONDUCT.md.

Maintainers

See CHANGELOG.md for the current maintainers and release history.