docs: README を repo-readme の型に合わせ、である調に揃える - #68
Merged
Merged
Conversation
- 地の文をである調に揃える - H1 直下のコアメッセージを「本リポジトリは」で始め、何を実証するかと手段を1文に入れる - Tech Stack 節を Reason 列つきで足す - 役割の分離に、ローカルとリモートの境界と abort の分岐を示す図を足す - 動かす手順を載せない理由を What Is Not Here に書く
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
1 participant
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.
概要
#67 の README は ですます調で、
repo-readmeの Type A の下限（コアメッセージの形・技術選定の Why）も満たしていなかった。構成と内容は #67 のまま、型に合わせて直す。変更
| Layer | Technology | Reason |の表を足すissue-abortの分岐を示す図を足す。実行者がリモートへ出る経路を持たない点を図で示す（mermaid-diagramの「境界」「分岐」に当たる）検証手順