Skip to content

contributing.md

Latest commit

 

History

History
69 lines (52 loc) · 2.6 KB

contributing.md

File metadata and controls

69 lines (52 loc) · 2.6 KB
Raw

Contributing

This is an evolving field guide, not a finished product. Suggestions, corrections and scenario contributions are welcome.

What this repo wants

  • Plain-English explanations of Purview, Fabric and Azure data security topics that practitioners actually struggle with.
  • Scenario write-ups that show how the accelerator and the wider Purview surface play out in real work.
  • Corrections when something here drifts from the official Microsoft Learn content.
  • Pointers to relevant content elsewhere, especially in the accelerator repo and Microsoft Learn.

What this repo does not want

  • Re-implementation of anything the accelerator already does. If a capability belongs in automation, raise it with the accelerator team instead.
  • Vendor marketing language. Keep the tone calm, direct and practical.
  • Long explanations of well-documented portal mechanics. Link to Microsoft Learn rather than mirroring it.

How to open an issue

Use GitHub Issues on this repo. Helpful issues usually include:

  • The page or section you are commenting on.
  • What is unclear, wrong or missing.
  • A link to the relevant Microsoft Learn page if you have one.

If you are flagging drift from Microsoft Learn, include the date you checked and the URL.

How to open a pull request

  1. Fork the repo and create a branch off main.
  2. Make the change. Keep changes focused. One topic per pull request.
  3. Use UK spelling. Keep paragraphs short. Avoid em and en dashes.
  4. Cite primary sources for any factual claim about Purview, Fabric or Defender.
  5. Open the pull request against main. Describe what changed and why in two or three sentences.

You do not need to wait for an issue to exist before opening a pull request for a small fix.

Style notes

  • en-GB English. "Organisation", "behaviour", "labelling".
  • Short paragraphs. Simple headings.
  • No em dashes. No en dashes. Use full stops or commas instead.
  • No hype. No scoring frameworks. No "secret sauce".
  • Mark anything not personally validated with a clear TODO and a pointer to what would need to be confirmed.

A note about the pace of this repo

The maintainer is on parental leave for part of 2026. Responses to issues and pull requests will be slower than usual during that time. Contributions are still welcome.

If a contribution is time-sensitive and relates to the accelerator itself, the Microsoft accelerator repo is the better destination.