Conversation
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.
What
Adds the standard documentation files expected in a public Go library repo.
README.md— overview, package table, usage examples for every sub-package, and development commandsCONTRIBUTING.md— prerequisites, development workflow, commit conventions, and PR processCHANGELOG.md— keep-a-changelog format, seeded with the current unreleased feature setSECURITY.md— vulnerability reporting contact and scope note.github/ISSUE_TEMPLATE/bug_report.md— structured bug report template.github/ISSUE_TEMPLATE/feature_request.md— structured feature request templateNote:
LICENSE(Apache 2.0) was added directly via the GitHub UI and is already onmain.Why
The repo had no documentation beyond code comments. These files cover the minimum expected by anyone evaluating or contributing to an open source Go library.
Test Plan
No code changes — review each file for accuracy against the actual API.
Checklist
make testpassesmake lintpasses