Add contrib mode, and rename 'check' to 'needs'#15
Merged
Conversation
Owner
Author
Collaborator
|
Will check this out tomorrow! |
Discover and parse CONTRIBUTING.md, DEVELOPMENT.md, DEVELOPERS.md, and HACKING.md alongside the README. Contributor docs appear in all modes with a file separator, and `hdi contrib` filters to only those files. Rename the `check|c` subcommand to `needs|n`, freeing the `c` alias for contrib.
Owner
Author
|
@maxelkins did you have a chance to play with this? Wondering if the vertically stacked UI is fine for v1, and can iterate on it for the next release... |
eg. when rendering CONTRIBUTING.md under the README.md content, needed clearly delineation
Owner
Author
|
Have made the file separate more visually distinct, and added the I think this is good enough for v1... |
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.

Discover and parse "contributor"-focused docs (ie. CONTRIBUTING.md, DEVELOPMENT.md, DEVELOPERS.md, and HACKING.md) alongside the README.
Contributor docs appear in all modes with a file separator, and
hdi contribfilters to only those files.Renames the
check/csubcommand toneeds/n, freeing thecalias for contrib (slightly suboptimal, but feels like the best compromise in order to maintain the most obvious single-char aliases).Test using:
And:
And for completeness, the renamed
check->needscommand:Considerations:
contriboutput at the top, rather than under the parsedreadmeoutput?contriboutput?Will need to ensure that all docs, including website demos, are updated with the changes here.