-
Notifications
You must be signed in to change notification settings - Fork 0
Add comprehensive GitHub Copilot instructions, merge main branch updates, and bump version to 4.0.2 #30
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Luke Bearden <luke.bearden@gmail.com>
Co-authored-by: lukebrdn <3859351+lukebrdn@users.noreply.github.com> Signed-off-by: Luke Bearden <luke.bearden@gmail.com>
873d929 to
407a681
Compare
|
@copilot bump the package version according to the PR label |
Package version bumped from 4.0.0 to 4.0.1 according to the PATCH label. Commit: 2504080 |
|
@copilot please bump this PR's version relative to what's in main |
Package version bumped to 4.0.2 relative to main branch (which has 4.0.1). Commit: de08b4e |
|
@copilot regenerate the package-lock so that it includes the updated package version |
Package-lock.json regenerated to include the updated version 4.0.2. The version fields in the lock file now match the package.json version. Commit: ae8a2ea |
|
@copilot resolve conflicts |
Co-authored-by: lukebrdn <3859351+lukebrdn@users.noreply.github.com> Signed-off-by: Luke Bearden <luke.bearden@gmail.com>
Co-authored-by: lukebrdn <3859351+lukebrdn@users.noreply.github.com> Signed-off-by: Luke Bearden <luke.bearden@gmail.com>
…ges (#28) Signed-off-by: Luke Bearden <luke.bearden@gmail.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: lukebrdn <3859351+lukebrdn@users.noreply.github.com> Co-authored-by: Luke Bearden <luke.bearden@gmail.com>
60b6cbd to
b284e3a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds comprehensive GitHub Copilot instructions for the hash library, integrates main branch updates, and bumps the version to 4.0.2. The main focus is providing detailed developer guidance and documentation for working with the TypeScript utility library that generates UUIDs from hash values.
- Adds a detailed
.github/copilot-instructions.mdfile with setup, build, test, and troubleshooting guidance - Merges updates from main branch (v4.0.1) including dependency updates
- Bumps package version from 4.0.1 to 4.0.2
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| package.json | Version bump from 4.0.1 to 4.0.2 |
| .github/copilot-instructions.md | New comprehensive documentation file with setup instructions, build commands, testing scenarios, and troubleshooting guidance |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
| tar -xJf node.tar.xz | ||
| export PATH=$PWD/node-v22.12.0-linux-x64/bin:$PATH | ||
| node --version # Should show v22.12.0 or higher | ||
| ``` |
Copilot
AI
Aug 12, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The installation instructions assume a Linux x64 environment but don't provide alternatives for other operating systems (Windows, macOS, ARM architectures). Consider adding platform-specific installation commands or referencing the official Node.js installation guide.
| ``` | |
| - **Install Node.js 22.12.0 or later**: | |
| > **Note:** The following instructions are for Linux x64. For other platforms (Windows, macOS, ARM), please refer to the [official Node.js installation guide](https://nodejs.org/en/download/) for platform-specific instructions. | |
| **Linux x64 example:** | |
| ```bash | |
| curl -fsSL https://nodejs.org/dist/v22.12.0/node-v22.12.0-linux-x64.tar.xz -o node.tar.xz | |
| tar -xJf node.tar.xz | |
| export PATH=$PWD/node-v22.12.0-linux-x64/bin:$PATH | |
| node --version # Should show v22.12.0 or higher |
macOS example (using Homebrew):
brew install node@22
node --version # Should show v22.12.0 or higherWindows example (using Chocolatey):
choco install nodejs-lts --version=22.12.0
node --version # Should show v22.12.0 or higherThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
applied
| ### Core Functionality | ||
|
|
||
| - `hash(value: string): string` - Generates UUID from SHA-512 hash of input | ||
| - Uses custom UUID v5 implementation with namespace `f25d4515-fea7-44c7-8baf-f3ca50865e66` |
Copilot
AI
Aug 12, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The hardcoded namespace UUID should be documented with its purpose or significance. Consider explaining why this specific namespace is used or if it's project-specific.
| - Uses custom UUID v5 implementation with namespace `f25d4515-fea7-44c7-8baf-f3ca50865e66` | |
| - Uses custom UUID v5 implementation with namespace `f25d4515-fea7-44c7-8baf-f3ca50865e66` | |
| - This namespace UUID is project-specific and was randomly generated for this library to ensure deterministic UUID generation. It should not be reused across unrelated projects. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
eh.
bobwieler
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lftm
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
.github/copilot-instructions.md
Outdated
|
|
||
| ## Critical Requirements | ||
|
|
||
| **REQUIRED NODE.JS VERSION**: This project requires Node.js 22.11 or higher for the `--experimental-strip-types` feature. The CI pipeline runs on Node.js 22.x and 23.x. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
24.x?
| **Linux x64 example:** | ||
|
|
||
| ```bash | ||
| curl -fsSL https://nodejs.org/dist/v22.12.0/node-v22.12.0-linux-x64.tar.xz -o node.tar.xz |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should tell it to test with both 22 and 24 somewhere explicitly
|
Beta Published - Install Command: |
|
❌ PR review status - not all reviewers have approved - 2 approved - 1 outstanding |
This PR adds a comprehensive
.github/copilot-instructions.mdfile that provides detailed guidance for GitHub Copilot and developers working with the hash library codebase, merges updates from the main branch, and bumps the package version to 4.0.2.Key Features
Critical Requirements Documentation
--experimental-strip-typesfeatureValidated Command Instructions
All commands have been thoroughly tested and include measured timing:
npm ci --ignore-scripts- ~7 seconds (dependency installation)npm run ci:compile- ~3 seconds (TypeScript type checking)npm run ci:test- <1 second (5 tests with Node.js test runner)npm run ci:lint- ~4-6 seconds (ESLint validation)npm run ci:style- ~7 seconds (Prettier formatting check)npm run prepublishOnly- ~4 seconds (builds dist-types and dist-mjs)npm test- ~15 seconds total (complete CI suite)Manual Validation Scenarios
Includes specific test commands to verify:
Architecture Documentation
Troubleshooting Guidance
Timing Expectations with Safety Margins
All timeout recommendations include "NEVER CANCEL" warnings with generous buffers to prevent premature command termination during CI processes.
Main Branch Integration
This PR also merges updates from the main branch (v4.0.1) which included:
@checkdigit/prettier-configdependency to version 7.1.1Version Update
Bumps package version from 4.0.0 to 4.0.2 to be relative to the current main branch version (4.0.1). Package-lock.json has been regenerated to match the updated version and incorporate the latest dependency updates.
The instructions follow an imperative tone as specified and prioritize validated, working commands over theoretical guidance. Every command was executed and timed to ensure accuracy.
Fixes #29.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.