Conversation
…DME with contributing guidelines and Copilot instructions
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the repository’s contributor experience by adding GitHub issue form templates and documenting contribution/Copilot conventions for this courseware repo.
Changes:
- Added GitHub Issue Forms for bug reports and feature requests under
.github/ISSUE_TEMPLATE/. - Added a repository-level
.github/copilot-instructions.mddescribing writing/content/sample-code conventions. - Updated
README.mdwith an “AI Ready” badge and a new Contributing section.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds AI Ready badge and a new Contributing section for contributors. |
| .github/copilot-instructions.md | Introduces repo-specific Copilot guidance, conventions, and a maintenance matrix. |
| .github/ISSUE_TEMPLATE/feature-request.yml | Adds a structured issue form for feature/content requests. |
| .github/ISSUE_TEMPLATE/bug-report.yml | Adds a structured issue form for reporting bugs in course content/examples. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 4/4 changed files
- Comments generated: 3
Comment on lines
+95
to
+106
| - 🤝 **Want to contribute?** PRs welcome! | ||
| - 📚 **Official Docs:** [GitHub Copilot CLI Documentation](https://docs.github.com/copilot/concepts/agents/about-copilot-cli) | ||
|
|
||
| ## Contributing | ||
|
|
||
| > **Note**: The code used in the course is designed to generate specific types of output during reviews, explanations, and debugging so we aren't able to accept PRs that change the existing code. | ||
|
|
||
| **How to contribute:** | ||
|
|
||
| 1. Fork this repository and clone it to your machine | ||
| 2. Create a feature branch (`git checkout -b my-improvement`) | ||
| 3. Make your changes |
There was a problem hiding this comment.
This note says PRs that change existing code can’t be accepted, but the README also says “PRs welcome”. To avoid confusion, clarify what kinds of PRs are accepted (e.g., docs/typos/templates) and what isn’t (changes to exercise code).
Suggested change
| - 🤝 **Want to contribute?** PRs welcome! | |
| - 📚 **Official Docs:** [GitHub Copilot CLI Documentation](https://docs.github.com/copilot/concepts/agents/about-copilot-cli) | |
| ## Contributing | |
| > **Note**: The code used in the course is designed to generate specific types of output during reviews, explanations, and debugging so we aren't able to accept PRs that change the existing code. | |
| **How to contribute:** | |
| 1. Fork this repository and clone it to your machine | |
| 2. Create a feature branch (`git checkout -b my-improvement`) | |
| 3. Make your changes | |
| - 🤝 **Want to contribute?** Documentation, typo, link-fix, and template PRs are welcome. Please see [Contributing](#contributing) for details. | |
| - 📚 **Official Docs:** [GitHub Copilot CLI Documentation](https://docs.github.com/copilot/concepts/agents/about-copilot-cli) | |
| ## Contributing | |
| > **Note**: The code used in the course is designed to generate specific types of output during reviews, explanations, and debugging, so we aren't able to accept PRs that change the existing exercise or course code. | |
| > | |
| > We do welcome PRs for non-code improvements such as: | |
| > - fixing typos or grammar | |
| > - improving documentation or instructions | |
| > - correcting broken links | |
| > - updating templates, metadata, or other repository content that does not change the exercise behavior | |
| > | |
| > If you're unsure whether a change is in scope, please open an issue first. | |
| **How to contribute:** | |
| 1. Fork this repository and clone it to your machine | |
| 2. Create a feature branch (`git checkout -b my-improvement`) | |
| 3. Make your non-code changes |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
Summary
This PR adds issue templates and enhances the repo's contributor experience:
.github/ISSUE_TEMPLATE/bug-report.yml) — structured form with chapter dropdown, environment details, and screenshot fields.github/ISSUE_TEMPLATE/feature-request.yml) — structured form for proposing new content or improvementsThese changes were previously committed directly to
mainbut the push was blocked by a pending CodeQL scan. This PR routes around the branch protection rule.