diff --git a/.github/ISSUE_TEMPLATE/CopilotIssue.yml b/.github/ISSUE_TEMPLATE/CopilotIssue.yml index 7dd68394..feff6ebd 100644 --- a/.github/ISSUE_TEMPLATE/CopilotIssue.yml +++ b/.github/ISSUE_TEMPLATE/CopilotIssue.yml @@ -1,6 +1,6 @@ name: Copilot Issue description: Create an issue to be assigned to GitHub Copilot for automated resolution. -title: "[Copilot] " +title: "[Copilot]: " labels: ["copilot"] body: - type: markdown diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..57b5a844 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,37 @@ +--- +name: Bug report +about: Report a bug in azldev +title: "[Bug]: " +labels: bug + +--- + +**Bug Description** +A clear and concise description of what the bug is. + +**Reproduction Steps** +Steps to reproduce the behavior: + +- Command line used (paste the full command): +- Relevant configuration or inputs: +- Any additional steps: + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Actual behavior** +What actually happened? Include error messages verbatim. + +**Logs / Output** +Please attach or paste relevant output (for example: `--verbose` logs, failing test output, stack traces). + +**azldev version** +Output from `azldev version`: + +**Environment** +- Host OS and version (for example: Azure Linux 4.0, Ubuntu 24.04): +- Azure Linux version being targeted (for example: 4.0): +- Host architecture (`x86_64` / `arm64`): + +**Additional context** +Add any other context, screenshots, or related links here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..afd9a6ac --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Security vulnerability + url: https://github.com/microsoft/azure-linux-dev-tools/security/policy + about: Please report security vulnerabilities privately via the Microsoft Security Response Center (see SECURITY.md). Do NOT open a public issue. + - name: Azure Linux distro issues + url: https://github.com/microsoft/azurelinux/issues + about: "For issues with Azure Linux itself (for example: distro packages, kernel, base image content), please file in the azurelinux repo." diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 00000000..0f7c2f7f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,21 @@ +--- +name: Documentation issue +about: Report a problem with docs or suggest a documentation improvement +title: "[Docs]: " +labels: documentation + +--- + +**Which documentation page is affected?** +Provide the repository path(s) to the affected page(s). + +- Repo path: `docs/...` + +**What is wrong or missing?** +A clear and concise description of the issue (for example: incorrect information, broken link, outdated example, missing section, unclear wording). + +**Suggested fix** +If you have a suggestion for how the docs should read, share it here. + +**Additional context** +Add any other context, screenshots, or references that would help us improve the docs. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..e1e48f2e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,32 @@ +--- +name: Feature request +about: Suggest a new feature or enhancement for azldev +title: "[Feature]: " +labels: enhancement + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +If it involves a CLI change, suggest it here: + +```bash +# proposed command usage +azldev ... +``` + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions, workarounds, or approaches you have considered. + +**Use case / impact** +Who benefits from this feature and how? + +**azldev version** +Version you are currently using, if applicable (`azldev version`): + +**Additional context** +Add any other context, references, or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/questions_feedback.md b/.github/ISSUE_TEMPLATE/questions_feedback.md new file mode 100644 index 00000000..77c7392a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/questions_feedback.md @@ -0,0 +1,19 @@ +--- +name: Question / Feedback +about: Ask a general question or share feedback that is not a bug or feature request +title: "[Question]: " +labels: question + +--- + +**Your question or feedback** +A clear and concise description of your question or feedback. + +**Environment (if relevant)** +- azldev version (`azldev version`): +- Host OS and architecture: +- Azure Linux version being targeted (for example: 4.0): +- Relevant command: + +**Additional context** +Add screenshots, output, or any other context that would help us answer. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a4d85825..16e7528f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,12 @@ # Contribution Guidelines +## 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. + +Guidelines specific to this repo can be found below. + ## Contributing License Agreement This project welcomes contributions and suggestions. Most contributions require you to agree to a diff --git a/README.md b/README.md index 4856b570..d0da0c31 100644 --- a/README.md +++ b/README.md @@ -64,8 +64,7 @@ For development setup and workflow, please consult our [Developer Guide](./docs/ ## Getting Help -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). +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/choose). For guidance on how to file an issue, see [how to report issues](https://aka.ms/azurelinux-reportissues). For security issues, please see the [security policy](./SECURITY.md). diff --git a/SUPPORT.md b/SUPPORT.md index 1928fb05..43f987f2 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -2,7 +2,7 @@ ## 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 [bug reports][gh-bug], [feature requests][gh-feature], [documentation issues][gh-docs], and [questions or feedback][gh-question]. Pick the matching template when opening a new issue. Please search existing issues to avoid duplicates before filing a new one. For guidance, see [how to report issues](https://aka.ms/azurelinux-reportissues). For questions about using this project, please consult our [User Guide](./docs/user). If you want to contribute to this project, please review our [Contribution Guidelines](./CONTRIBUTING.md) and our [Developer Guide](./docs/developer). @@ -11,5 +11,7 @@ For questions about using this project, please consult our [User Guide](./docs/u Support for this project is limited to the resources listed above. [gh-issue]: https://github.com/microsoft/azure-linux-dev-tools/issues/new/choose -[gh-bug]: https://github.com/microsoft/azure-linux-dev-tools/issues/new?labels=bug -[gh-feature]: https://github.com/microsoft/azure-linux-dev-tools/issues/new?labels=enhancement +[gh-bug]: https://github.com/microsoft/azure-linux-dev-tools/issues/new?template=bug_report.md +[gh-feature]: https://github.com/microsoft/azure-linux-dev-tools/issues/new?template=feature_request.md +[gh-docs]: https://github.com/microsoft/azure-linux-dev-tools/issues/new?template=documentation.md +[gh-question]: https://github.com/microsoft/azure-linux-dev-tools/issues/new?template=questions_feedback.md