Skip to content

Add contrib mode, and rename 'check' to 'needs'#15

Open
grega wants to merge 1 commit intomainfrom
contrib-support
Open

Add contrib mode, and rename 'check' to 'needs'#15
grega wants to merge 1 commit intomainfrom
contrib-support

Conversation

@grega
Copy link
Copy Markdown
Owner

@grega grega commented Mar 26, 2026

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 contrib filters to only those files.

Renames the check / c subcommand to needs / n, freeing the c alias for contrib (slightly suboptimal, but feels like the best compromise in order to maintain the most obvious single-char aliases).


Test using:

./hdi test/fixtures/node-express

And:

./hdi c test/fixtures/node-express

And for completeness, the renamed check -> needs command:

./hdi n test/fixtures/node-express
./hdi n test/fixtures/java-spring
./hdi n test/fixtures/rust-cargo

Considerations:

  • A keyboard shortcut to jump between files? (similar to current tabbing, but between file headers)
  • Preference to always show contrib output at the top, rather than under the parsed readme output?
    • Also maybe only show contrib output?
  • Not convinced more vertical stacking is the way to solve this (eg. there's going to be a lot of content if we're parsing a README.md, CONTRIBUTING.md and a DEVELOPMENT.md, for example), maybe there needs to be some sort of "tabbed" (visually) interface
    • Perhaps this is fine for v1...
    • There could also be duplication between these files, but can de-dupe to some extent
  • ...

@grega grega changed the title Add contrib mode and rename 'check' to 'needs'. Add contrib mode, and rename 'check' to 'needs' Mar 26, 2026
@grega
Copy link
Copy Markdown
Owner Author

grega commented Mar 26, 2026

Screenshot 2026-03-26 at 22 48 24

@maxelkins
Copy link
Copy Markdown
Collaborator

Will check this out tomorrow!

@grega grega marked this pull request as ready for review March 27, 2026 20:14
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.
@grega grega force-pushed the contrib-support branch from 5009a14 to 3ea9b41 Compare March 27, 2026 20:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants