Skip to content

📖 [Docs]: Software design principles now cover smart defaults and local overrides#14

Merged
Marius Storhaug (MariusStorhaug) merged 2 commits into
mainfrom
docs/smart-defaults-principle
Jul 4, 2026
Merged

📖 [Docs]: Software design principles now cover smart defaults and local overrides#14
Marius Storhaug (MariusStorhaug) merged 2 commits into
mainfrom
docs/smart-defaults-principle

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Jul 4, 2026

Copy link
Copy Markdown
Member

The software design principles now include smart defaults, local overrides — how to set a safe, sensible default once at the broadest scope and let it be overridden closer to the item it controls. Readers and agents get a single principle to point at when deciding where a setting belongs and how far a default should reach.

New: "Smart defaults, local overrides" principle

Added under Software design, beside "Extensible by default". It states:

  • The default is the smart, secure choice; a zero-config system is already correct and safe. Configuration exists to deviate from a good default, not to reach a usable one.
  • Defaults are set at the broadest scope and overridden closer to the item — the most specific setting wins, predictably by position in the hierarchy, never by special-casing.
  • The shape is chosen for long-term manageability: change the wide default once and everything that has not opted out follows; deviating is a small, local edit beside the item that needs it.

It consolidates ideas already in the docs rather than restating them — cross-linking the Easy/Safe value, least-privilege, secure by default, and the vision cascade.

Technical Details

  • src/docs/Ways-of-Working/Principles/Software-Design.md — new ## Smart defaults, local overrides section plus an updated front-matter description.
  • src/docs/Ways-of-Working/Principles/index.md — Software design row updated to match the new description, keeping the auto-generated index in sync (Update-DocumentationIndex.ps1 -Check passes).
  • Quality gates green locally: markdownlint, textlint, codespell, documentation link check, and index-drift check.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new software design principle to the Ways of Working documentation, clarifying how to choose safe defaults at broad scope while allowing predictable, local overrides closer to the configured item.

Changes:

  • Updated the Software design page front-matter description and added a new “Smart defaults, local overrides” section.
  • Updated the Principles index entry for Software design to reflect the new description.

Reviewed changes

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

File Description
src/docs/Ways-of-Working/Principles/Software-Design.md Adds the new “Smart defaults, local overrides” principle section and updates the page description.
src/docs/Ways-of-Working/Principles/index.md Updates the Software design row description inside the generated index table.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/docs/Ways-of-Working/Principles/Software-Design.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@MariusStorhaug Marius Storhaug (MariusStorhaug) marked this pull request as ready for review July 4, 2026 22:48
@MariusStorhaug Marius Storhaug (MariusStorhaug) merged commit 7a87e7e into main Jul 4, 2026
20 checks passed
@MariusStorhaug Marius Storhaug (MariusStorhaug) deleted the docs/smart-defaults-principle branch July 4, 2026 22:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants