Skip to content

docs: rewrite README and add CONTRIBUTING.md#3

Draft
samikroy with Copilot wants to merge 2 commits into
mainfrom
copilot/document-repo
Draft

docs: rewrite README and add CONTRIBUTING.md#3
samikroy with Copilot wants to merge 2 commits into
mainfrom
copilot/document-repo

Conversation

Copilot AI commented Feb 25, 2026

Copy link
Copy Markdown

The repo lacked structured documentation — the README had formatting issues, typos, and missing setup context.

README.md

  • Added project description lede
  • Features list → proper Markdown table
  • Fixed typos: "Snapshort", "service principaln"
  • Added Prerequisites section and numbered Setup guide with a GitHub Secrets reference table
  • Added Customizing KQL Queries section documenting the Title >> KQL line format and a reference table of all 10 built-in checks
  • Replaced hardcoded absolute GitHub URLs with relative links

CONTRIBUTING.md (new)

  • How to file issues, propose KQL queries, modify the PowerShell script, and submit PRs

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: samikroy <20562985+samikroy@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for repository docs: rewrite README and add CONTRIBUTING.md Feb 25, 2026
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