docs: add GitHub issue templates and refresh contribution docs#205
Draft
kavyamsft wants to merge 9 commits into
Draft
docs: add GitHub issue templates and refresh contribution docs#205kavyamsft wants to merge 9 commits into
kavyamsft wants to merge 9 commits into
Conversation
Adds .github/ISSUE_TEMPLATE/ with bug_report, feature_request, documentation, and questions-feedback templates plus an issue chooser config.yml (disables blank issues, adds contact links for the user guide, security policy, and the azurelinux distro repo). Modeled on microsoft/azure-linux-image-tools#741 but tailored for azldev (CLI/version/Azure Linux target prompts). Also links the Azure Linux contribution philosophy in CONTRIBUTING.md and the report-issues guidance in README.md/SUPPORT.md.
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates project docs and GitHub issue intake to better route users and standardize how bugs/features/questions/docs issues are filed.
Changes:
- Update SUPPORT.md and README.md to link to centralized “how to report issues” guidance.
- Add GitHub Issue Forms (markdown templates + config.yml) and disable blank issues.
- Add a CONTRIBUTING.md section linking to Azure Linux contribution philosophy/best practices.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| SUPPORT.md | Rewords support guidance and links to centralized issue-reporting docs. |
| README.md | Expands “Getting Help” with a link to issue-reporting guidance. |
| CONTRIBUTING.md | Adds upstream contribution philosophy/best-practices link ahead of repo-specific guidance. |
| .github/ISSUE_TEMPLATE/questions-feedback.md | Adds a structured template for questions/feedback. |
| .github/ISSUE_TEMPLATE/feature_request.md | Adds a structured template for feature requests. |
| .github/ISSUE_TEMPLATE/documentation.md | Adds a structured template for documentation issues. |
| .github/ISSUE_TEMPLATE/bug_report.md | Adds a structured template for bug reports. |
| .github/ISSUE_TEMPLATE/config.yml | Disables blank issues and adds contact links for security + distro issues. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Removed newline at end of file and adjusted context prompt.
Removed unnecessary newline at the end of the file.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Comment on lines
67
to
+68
| Have questions, found a bug, or need a new feature? Open an issue in our [GitHub | ||
| repository](https://github.com/microsoft/azure-linux-dev-tools/issues/new). | ||
| repository](https://github.com/microsoft/azure-linux-dev-tools/issues/new/choose). For guidance on how to file an issue, see [how to report issues](https://aka.ms/azurelinux-reportissues). |
| ## How to file issues and get help | ||
|
|
||
| This project uses [GitHub issues][gh-issue] to [track bugs][gh-bug] and [feature requests][gh-feature]. Please search the existing issues before filing new issues to avoid duplicates. For new topics, file your bug or feature request as a new issue. | ||
| This project uses [GitHub issues][gh-issue] to [track bugs][gh-bug] and [feature requests][gh-feature]. Please search existing issues to avoid duplicates before filing a new one. For guidance, see [how to report issues](https://aka.ms/azurelinux-reportissues). |
Comment on lines
+5
to
+6
| labels: bug | ||
|
|
Member
|
@kavyamsft The changes look pretty good to me, thanks for putting this together! I think the only thing is just those external doc links going live. |
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.
What
Adds a
.github/ISSUE_TEMPLATE/folder with issue templates for this repo and refreshesCONTRIBUTING.md,README.md, andSUPPORT.md.Issue templates
bug_report.md— azldev bug reports including version, repro steps, logs, host OS/arch, and Azure Linux target version.feature_request.md— feature/enhancement proposals with proposed CLI/config sketches and use-case impact.documentation.md— documentation issues with repo path / URL.questions-feedback.md— general questions and feedback.config.yml— issue chooser config with contact links to the user guide, the Microsoft security reporting process (perSECURITY.md), and the upstreammicrosoft/azurelinuxrepo. Blank issues remain disabled.Docs
CONTRIBUTING.md: link to the Azure Linux contribution philosophy / best practices.README.mdandSUPPORT.md: point users at the Azure Linux report-issues guidance.Why
Gives issues structured prompts so we get the information needed to triage (version, command line, config, logs, environment) and aligns guidance with other AzL repos.