docs: add reproduction guide and update bug report template - #5451
Merged
mcollina merged 2 commits intoJul 4, 2026
Merged
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
… template This adds a comprehensive Reproduction section to CONTRIBUTING.md with: - Guidelines for creating good bug reproductions - Standalone server pattern using createServer + Client - Fetch-based reproduction examples - Pool/Agent reproduction examples - Checklist for bug reporters The bug report template is updated to prominently request a standalone reproduction script and include structured Environment fields.
Copy link
Copy Markdown
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #5451 +/- ##
=======================================
Coverage 93.46% 93.47%
=======================================
Files 110 110
Lines 37106 37115 +9
=======================================
+ Hits 34682 34693 +11
+ Misses 2424 2422 -2 ☔ View full report in Codecov by Harness.
|
Sorry, something went wrong.
trivikr
reviewed
Jun 25, 2026
Comment thread
CONTRIBUTING.md
Outdated
Comment on lines
+230
to
+231
| const { tspl } = require('@matteo.collina/tspl') | ||
| t = tspl(t, { plan: 1 }) |
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
Should we recommend t.plan instead of tspl?
Suggested change
| const { tspl } = require('@matteo.collina/tspl') | |
| t = tspl(t, { plan: 1 }) | |
| t.plan(1) |
Ditto in other occurrences.
Sorry, something went wrong.
Comment thread
CONTRIBUTING.md
Outdated
| res.setHeader('content-length', 100) | ||
| res.end('hello'.repeat(20)) | ||
| }) | ||
| after(() => { server.closeAllConnections?.(); server.close() }) |
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
This should use t.after instead of global import
Suggested change
| after(() => { server.closeAllConnections?.(); server.close() }) | |
| t.after(() => { server.closeAllConnections?.(); server.close() }) |
Ditto at other places
Sorry, something went wrong.
metcoder95
approved these changes
Jun 26, 2026
metcoder95
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
lgtm with @trivikr suggestions
Sorry, something went wrong.
Signed-off-by: Matteo Collina <hello@matteocollina.com>
metcoder95
approved these changes
Jul 2, 2026
trivikr
approved these changes
Jul 2, 2026
Merged
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
Reviewers
4 participants
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.
Summary
Adds a comprehensive Reproduction guide to CONTRIBUTING.md and updates the bug report template to request standalone reproduction scripts.
CONTRIBUTING.md changes
Bug report template changes
Related Issues
Closes #N/A — this is a process/documentation improvement