Skip to content

feat: add bug report and feature request issue templates; enhance README with contributing guidelines and Copilot instructions#108

Merged
DanWahlin merged 4 commits intomainfrom
feat/issue-templates-and-copilot-instructions
Apr 28, 2026
Merged

feat: add bug report and feature request issue templates; enhance README with contributing guidelines and Copilot instructions#108
DanWahlin merged 4 commits intomainfrom
feat/issue-templates-and-copilot-instructions

Conversation

@DanWahlin
Copy link
Copy Markdown
Collaborator

Summary

This PR adds issue templates and enhances the repo's contributor experience:

  • Bug report template (.github/ISSUE_TEMPLATE/bug-report.yml) — structured form with chapter dropdown, environment details, and screenshot fields
  • Feature request template (.github/ISSUE_TEMPLATE/feature-request.yml) — structured form for proposing new content or improvements
  • README updates — enhanced Contributing section with test commands and link to AGENTS.md
  • Copilot instructions updates — refined conventions and maintenance matrix

These changes were previously committed directly to main but the push was blocked by a pending CodeQL scan. This PR routes around the branch protection rule.

…DME with contributing guidelines and Copilot instructions
Copilot AI review requested due to automatic review settings April 28, 2026 18:10
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

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 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.md describing writing/content/sample-code conventions.
  • Updated README.md with 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 thread README.md
Comment thread README.md Outdated
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
Copy link

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

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

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

Copilot uses AI. Check for mistakes.
Comment thread .github/copilot-instructions.md Outdated
DanWahlin and others added 2 commits April 28, 2026 11:17
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@DanWahlin DanWahlin merged commit fd7a0f9 into main Apr 28, 2026
3 checks passed
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.

2 participants