docs: cookbook + PR template - #69
Merged
Merged
Conversation
- docs/cookbook.md: task-oriented recipes covering parseSingle/parseMultiple, streaming, RFC presets, error codes + severity, UTF-8/IDN, canonical(), the local-part normalizer, confusable-domain detection, custom separators, and the legacy array API. Every snippet's output is verified against the parser. - .github/PULL_REQUEST_TEMPLATE.md: summary / behavior-impact / checklist (tests, cs, stan, changelog, RFC citations). - README links the cookbook; ROADMAP updated.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #69 +/- ##
============================================
- Coverage 96.01% 95.64% -0.38%
Complexity 434 434
============================================
Files 6 6
Lines 1078 1078
============================================
- Hits 1035 1031 -4
- Misses 43 47 +4 🚀 New features to boost your workflow:
|
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.
Two selective docs additions.
docs/cookbook.mdTask-oriented recipes — parse one/many, streaming, RFC presets, failure handling (reason/code/severity), UTF-8/IDN,
canonical(), local-part normalizer (Gmail dots/+tag), confusable-domain detection, custom separators, and the legacy array API. Every snippet's output is verified against the actual parser (see the verification run in the commit). Linked from the README's "Other docs" line..github/PULL_REQUEST_TEMPLATE.mdSummary / type-of-change / behavior-impact / checklist (tests,
cs:check,stan, CHANGELOG, RFC citations for parsing changes).Docs/tooling only — no code changes. ROADMAP updated (cookbook done; issue templates still open).