expand README generation prompts and default sections#14
Merged
Conversation
Capture richer project metadata during generate runs by adding flags and interactive prompts for features, usage examples, configuration notes, and contributor guidance. Improve the default renderer by: - deriving descriptions from package docs when available - inferring sensible default usage snippets from the package type - surfacing direct go.mod dependencies and common repo docs - linking contributing, security, and license files in the generated output Update the project documentation and add tests covering the new prompt flow, richer template rendering, and custom usage handling. Tests: go test ./...
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.
Capture richer project metadata during generate runs by adding flags and interactive prompts for features, usage examples, configuration notes, and contributor guidance.
Improve the default renderer by:
Update the project documentation and add tests covering the new prompt flow, richer template rendering, and custom usage handling.
Tests: go test ./...
Summary
Related issue
Closes #
Type of change
Checklist
go build ./...passesgo vet ./...passesgo test -race ./...passes