Skip to content

docs: update CONTRIBUTING, SUPPORT, and README#17391

Open
kavyamsft wants to merge 1 commit into
4.0from
kanagala/update-docs
Open

docs: update CONTRIBUTING, SUPPORT, and README#17391
kavyamsft wants to merge 1 commit into
4.0from
kanagala/update-docs

Conversation

@kavyamsft
Copy link
Copy Markdown

Merge Checklist

All boxes should be checked before merging the PR (just tick any boxes which don't apply to this PR)

  • The toolchain has been rebuilt successfully (or no changes were made to it)
  • The toolchain/worker package manifests are up-to-date
  • Any updated packages successfully build (or no packages were changed)
  • Packages depending on static components modified in this PR (Golang, *-static subpackages, etc.) have had their Release tag incremented.
  • Package tests (%check section) have been verified with RUN_CHECK=y for existing SPEC files, or added to new SPEC files
  • All package sources are available
  • cgmanifest files are up-to-date and sorted (./cgmanifest.json, ./toolkit/scripts/toolchain/cgmanifest.json, .github/workflows/cgmanifest.json)
  • LICENSE-MAP files are up-to-date (./LICENSES-AND-NOTICES/SPECS/data/licenses.json, ./LICENSES-AND-NOTICES/SPECS/LICENSES-MAP.md, ./LICENSES-AND-NOTICES/SPECS/LICENSE-EXCEPTIONS.PHOTON)
  • All source files have up-to-date hashes in the *.signatures.json files
  • sudo make go-tidy-all and sudo make go-test-coverage pass
  • Documentation has been updated to match any changes to the build system
  • Ready to merge

Summary

Standardizes guidelines across MS Learn and other Azure Linux repos.

Change Log
  • SUPPORT.md: added instructions for official production support
  • CONTRIBUTING.md: link to the Azure Linux contribution philosophy and best practices available on MS Learn
  • README.md: credit Larry Ewing for the Tux-inspired penguin icon
Does this affect the toolchain?

NO

Associated issues
Links to CVEs
Test Methodology

N/A

- SUPPORT.md: add 'how to report issues' link and a Questions heading
- CONTRIBUTING.md: link to the Azure Linux contribution philosophy and
  best practices
- README.md: credit Larry Ewing for the Tux-inspired penguin icon
Copilot AI review requested due to automatic review settings May 21, 2026 18:46
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

Updates repository documentation to align with standardized guidance across Azure Linux-related repos and Microsoft Learn, clarifying support channels and attribution.

Changes:

  • Adds a “Production support” section to SUPPORT.md clarifying when to use Azure Support vs GitHub issues.
  • Links CONTRIBUTING.md to the Azure Linux contribution philosophy/best-practices guidance on Microsoft Learn.
  • Adds attribution for the Azure Linux penguin icon inspiration in README.md.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
SUPPORT.md Clarifies production support vs GitHub issue intake; adds issue-reporting guidance link.
CONTRIBUTING.md Adds an upfront link to contribution philosophy/best practices guidance.
README.md Adds icon inspiration attribution in acknowledgments section.

Comment thread SUPPORT.md

## Questions

For questions about using this project, please look at our [Contributor's Guide][CONTRIBUTING.md].
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