Add GitHub issue templates and update docs#741
Conversation
- Add .github/ISSUE_TEMPLATE/ with bug_report, feature_request, documentation, questions-feedback templates and a config.yml chooser. - Link to Azure Linux contribution philosophy in CONTRIBUTING.md. - Point SUPPORT.md at the Azure Linux report-issues guidance.
Updated the host OS version in the bug report template.
| name: Feature request | ||
| about: Suggest a new feature or enhancement for Image Customizer | ||
| title: '[Feature]: ' | ||
| labels: feature-request |
There was a problem hiding this comment.
labels: feature-request doesn't match SUPPORT.md's [gh-feature] link (?labels=enhancement) or the companion PR microsoft/azure-linux-dev-tools#205, which uses enhancement. Suggest changing to labels: enhancement so the chooser, the SUPPORT link, and the sibling repo all agree.
| @@ -0,0 +1,8 @@ | |||
| blank_issues_enabled: false | |||
There was a problem hiding this comment.
Are you missing a contact link to the docs site?
| @@ -0,0 +1,43 @@ | |||
| --- | |||
There was a problem hiding this comment.
Do we care about osmodifier, or is the regarded as an internal-only tool?
| **Describe the bug** | ||
| A clear and concise description of what the bug is. | ||
|
|
||
| **Image Customizer version** |
There was a problem hiding this comment.
Companion PR has
Output from
azldev version:
Suggest:
Output from
imagecustomizer --version:
| about: Report a bug in Image Customizer | ||
| title: '[Bug]: ' | ||
| labels: bug | ||
| assignees: '' |
There was a problem hiding this comment.
assignees: [] (or just omit)
similar comment in the three other instances
| @@ -0,0 +1,43 @@ | |||
| --- | |||
There was a problem hiding this comment.
The link in the README.md's Getting Help section will be broken by blank_issues_enabled: false. Should update it to /issues/new/choose URL.
| What actually happened? Include error messages verbatim. | ||
|
|
||
| **Logs / Output** | ||
| Please attach or paste the relevant logs. |
There was a problem hiding this comment.
nit: trailing whitespace
| ## Azure Linux Contribution Philosophy and Best Practices | ||
|
|
||
| Before contributing, please review our [Azure Linux contribution philosophy and best practices](https://aka.ms/azurelinux-contributing). It covers the principles we follow when accepting changes and other guidance that will help | ||
| your PR land smoothly. |
There was a problem hiding this comment.
nit: why is there a line break here?
| **Describe the bug** | ||
| A clear and concise description of what the bug is. | ||
|
|
||
| **Image Customizer version** |
There was a problem hiding this comment.
Adding "Image Customizer version" and "To Reproduce" before fully describing the bug feels backwards.
Consider moving "To Reproduce" after "Logs / Output" and "Image Customizer version" after "Environment"
|
|
||
| --- | ||
|
|
||
| **Describe the bug** |
There was a problem hiding this comment.
Perhaps keep the titles in noun form instead of switching to the imperative.
- Describe the bug -> Bug description
- To Reproduce -> Reproduction steps
| @@ -0,0 +1,8 @@ | |||
| blank_issues_enabled: false | |||
There was a problem hiding this comment.
Are you missing docs-site contact link?
|
|
||
| ## Bugs | ||
|
|
||
| If the bug is security related, please use the [security guidelines](#security-vulnerabilities) above. Otherwise, please use the [issues page](https://github.com/microsoft/azure-linux-image-tools/issues) on Azure Linux Image Tools to file bugs. |
There was a problem hiding this comment.
Bugs section could either be removed (since CONTRIBUTING covers this) or updated
| @@ -0,0 +1,19 @@ | |||
| --- | |||
There was a problem hiding this comment.
Are discussions enabled for this repository?
2 participants
What
Adds a
.github/ISSUE_TEMPLATE/folder with templates for this repo and refreshesCONTRIBUTING.md/SUPPORT.md.Issue templates
bug_report.md— Image Customizer bug reports, including version, repro steps, logs, and environment (host OS/arch, base/target image format).feature_request.md— feature/enhancement proposals with proposed config sketch and use-case impact.documentation.md— documentation issues with page URL / repo path.questions-feedback.md— general questions and feedback.config.yml— issue chooser config with contact links to the docs site, 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.SUPPORT.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 the broader Azure Linux project.