Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates changelog formatting guidance and existing changelog entries to add explicit Markdown links for contributor usernames and issue references, aiming to make CHANGES.md easier to navigate.
Changes:
- Document a new CHANGES.md entry format that links
@usernamementions and#NNNreferences. - Convert existing CHANGES.md entries to use linked GitHub usernames.
- Convert
Fixes #NNNmentions to Markdown links to the corresponding GitHub issue pages.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
CLAUDE.md |
Updates contributor guidance for how to format CHANGES.md entries with links. |
CHANGES.md |
Applies the new linked-username/linked-issue formatting across the changelog. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| * [@bdeitte](https://github.com/bdeitte) Stop adding extra newline in buffering cases where it's not needed | ||
| * [@bdeitte](https://github.com/bdeitte) Flush buffering earlier when possible (reverted in 11.3.0) | ||
| * [@bdeitte](https://github.com/bdeitte) Add CLAUDE.md for easlier Claude usage | ||
| * [@bdeitte](https://github.com/bdeitte) Ensure client.close() does not throws errors when mock: true is set |
|
|
||
| ## 8.2.0 (2020-9-30) | ||
| * @dhermes Making UDS error handling and recovery more robust. Note these look to be ok in a minor release but are signficant upgrades to how UDS works. Thanks as well to @prognant for an overlapping PR. | ||
| * [@dhermes](https://github.com/dhermes) Making UDS error handling and recovery more robust. Note these look to be ok in a minor release but are signficant upgrades to how UDS works. Thanks as well to [@prognant](https://github.com/prognant) for an overlapping PR. |
|
|
||
| ## 2.3.1 (2016-2-3) | ||
| * @Pchelolo Ensure messages not larger then maxBufferSize | ||
| * [@Pchelolo](https://github.com/Pchelolo) Ensure messages not larger then maxBufferSize |
Comment on lines
178
to
180
| - Node.js >= 16.0.0 required (see `engines` in package.json) | ||
| - TypeScript definitions in types.d.ts must be updated for API changes | ||
| - Constructor parameter expansion is deprecated - use options object |
| - Mock mode available for testing (prevents actual metric sending) | ||
| - Add debug logging that can be enabled with "NODE_DEBUG=hot-shots" | ||
| - Updates should be noted in CHANGES.md using the format: `* @username Description`. For breaking changes, prefix with `Breaking:` (e.g., `* @username BREAKING: Description`). Do not use bold section headers. | ||
| - Updates should be noted in CHANGES.md using the format: `* [@username](https://github.com/username) Description`. For breaking changes, prefix with `Breaking:` (e.g., `* [@username](https://github.com/username) BREAKING: Description`). Do not use bold section headers. Always link `@username` mentions to their GitHub profiles and `#NNN` issue/PR references to `https://github.com/bdeitte/hot-shots/issues/NNN`. |
Comment on lines
4
to
+7
| ## Unreleased | ||
|
|
||
| * @bdeitte Upgrade mocha from 10.x to 11.x and fix all dev dependency security vulnerabilities (serialize-javascript, ajv) | ||
| * @bdeitte BREAKING: Drop Node.js 16 support, now requires Node.js >= 18.0.0 | ||
| * [@bdeitte](https://github.com/bdeitte) Upgrade mocha from 10.x to 11.x and fix all dev dependency security vulnerabilities (serialize-javascript, ajv) | ||
| * [@bdeitte](https://github.com/bdeitte) BREAKING: Drop Node.js 16 support, now requires Node.js >= 18.0.0 |
| * [@bdeitte](https://github.com/bdeitte) Enable buffering by default (as 8192) for UDS connections | ||
| * [@bdeitte](https://github.com/bdeitte) Stop adding extra newline in buffering cases where it's not needed | ||
| * [@bdeitte](https://github.com/bdeitte) Flush buffering earlier when possible (reverted in 11.3.0) | ||
| * [@bdeitte](https://github.com/bdeitte) Add CLAUDE.md for easlier Claude usage |
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
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.
Fixes #311