Repository navigation
* the README follows the house convention - #21
Merged
Merged
Conversation
The README opened with the package table: a reader learned which nine packages exist before learning what any of them are for, or how to install one. Adds Vision, Features, Installation and Quick start above it, and moves Packages onto an emoji that is not the one the vocabulary reserves for a support matrix. Also shortens the tagline, which ran to five hundred characters of hedged prose and three Wikipedia links. Switches the repo-readme check on so it stays that way.
The package-README check has been failing on this repository independently of this branch: Backports, System.Drawing.Extensions and System.Windows.Forms.Extensions carry REFERENCE.md files generated before a batch of XML summaries was written, so their Summary cells are blank where the assembly now has documentation. Taken verbatim from the package-readmes artifact the failing run uploaded, which is what CONTRIBUTING.md prescribes - the generated output is SDK-dependent, and CI has the SDK that produced the expectation. Newlines normalized to LF; the run was on a Windows runner. Nothing but blank cells gaining text.
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.
Brings this repository's README into line with the house convention now defined in
repo-readme/README.md,and switches the check on so it stays that way.
The README is a funnel: the pitch catches the reader,
🧭 Visionand✨ Featuressay what the thingis,
📦 Installationand🚀 Quick startget them running, the middle goes deeper, and what acontributor needs closes the file. One emoji means one thing, and a section shared with the package
README convention carries the same name and emoji in both.
No prose was dropped — sections were renamed, reordered, and where the convention asks for something
that was missing, it was written.