Repository navigation
docs: align README install and safety sections - #1
Merged
Merged
Conversation
9 tasks done
There was a problem hiding this comment.
Pull request overview
Updates the preset’s README to match the newer public README structure by adding a small metadata block, concrete install examples, and explicit safety/boundary notes—without changing preset behavior or versions.
Changes:
- Added README metadata fields (status, priority) and refined the requirements line.
- Added installation examples for tag-based and local dev installs.
- Added a “Safety / Grenzen” section clarifying non-goals and authority boundaries.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
README.md:136
- This sentence is a bit ungrammatical/ambiguous (“decisions such as C3A/C5
N/A”). Consider rephrasing so it’s clear you mean setting C3A/C5 toN/A(or marking it asN/A).
- Architecture applicability decisions such as C3A/C5 `N/A` require explicit
project evidence.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
README.md:28
- In the English summary,
N/Ais referenced without backticks (“justified N/A decisions”), while elsewhere in the READMEN/Ais consistently formatted as code. This looks like a missed spot and makes formatting inconsistent.
*The quality goal is reviewable architecture reasoning: trust boundaries,
attack surfaces, security quality goals, cloud dependencies, S-ADRs, and
justified N/A decisions should be visible before implementation.*
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updates the preset README to match the newer public preset README shape: metadata block, installation examples, and explicit safety/boundary notes. No preset behavior or version is changed.