Skip to content

Latest commit

Β 

History

History
75 lines (53 loc) Β· 2.5 KB

File metadata and controls

75 lines (53 loc) Β· 2.5 KB

🀝 Contributing to Copilot CLI Quick Start

First off β€” thank you! πŸ’œ Every contribution makes this tutor better for the next person learning Copilot CLI.

🎯 Ways to Contribute

πŸ’‘ No Code Required!

You don't need to write code to help. Open an Issue for any of these:

  • πŸ› Report a bug β€” Did a lesson confuse you? Tell us!
  • πŸ’‘ Suggest a lesson β€” What topic should we cover next?
  • ✏️ Fix a typo β€” Spotted a mistake? Let us know!
  • 🌍 Translation help β€” Want to help translate for non-English speakers?
  • 🎨 UX feedback β€” Was something intimidating or unclear?

πŸ§‘β€πŸ’» Code Contributions

  1. Fork this repo
  2. Create a branch: git checkout -b my-improvement
  3. Make your changes β€” see the development guide below
  4. Test your changes β€” see TESTING.md
  5. Open a PR β€” fill out the template and describe what you changed

πŸ› οΈ Development Setup

Prerequisites

Local Testing

  1. Clone the repo:

    git clone https://github.com/DUBSOpenHub/copilot-cli-quickstart.git
    cd copilot-cli-quickstart
  2. Register the skill locally in a Copilot CLI session:

    /skills add ./
    
  3. Test the tutorial flow:

    start tutorial
    
  4. Test Q&A mode:

    what does /plan do?
    
  5. Verify your changes against the TESTING.md playbooks.

πŸ“ What Makes a Good Contribution

  • πŸŽ‰ Keep the tone fun and friendly β€” emojis welcome!
  • 🐣 Assume zero CLI experience β€” explain everything
  • 🎯 One concept per lesson β€” don't overwhelm
  • ❌ Never fabricate β€” link to real docs
  • πŸ§ͺ Test your changes β€” run through the conversation flow
  • πŸ”„ Keep SKILL.md in sync β€” the skill file exists in two locations (skills/copilot-cli-quickstart/SKILL.md and .github/skills/copilot-cli-quickstart/SKILL.md). If you edit one, copy the changes to the other so they stay identical.

πŸ“‹ Pull Request Guidelines

  • Keep PRs focused β€” one improvement per PR
  • Update CHANGELOG.md with your change
  • Follow existing file naming conventions
  • If adding a lesson, include an exercise using ask_user

πŸ™ Code of Conduct

Please read our Code of Conduct. We're building an inclusive community! πŸ’œ