chore: add License section, slim publish tarball, switch repository URL to HTTPS - #7
Merged
Merged
Conversation
Replace .npmignore with package.json files allowlist (lib + CHANGELOG.md). Allowlist > denylist for npm publishing - future top-level files cannot accidentally leak. Identical 24-file tarball.
dusenko-godaddy
changed the title
isiddarta-godaddy
approved these changes
Jun 1, 2026
There was a problem hiding this comment.
Pull request overview
This PR updates project metadata and packaging configuration to better align with npm conventions and to reduce the size/surface area of the published npm tarball, while documenting the changes in the changelog.
Changes:
- Add a License section to the README pointing to the
LICENSEfile. - Configure
package.jsonwith afilesallowlist (publishlib/andCHANGELOG.mdplus npm defaults) and switchrepository.urlfrom SSH to HTTPS. - Record the above in
CHANGELOG.mdunder[Unreleased].
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Adds a ## License section linking to LICENSE. |
| package.json | Adds a publish allowlist via files and switches repository.url to HTTPS. |
| CHANGELOG.md | Documents the packaging and repository URL changes under [Unreleased]. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
## Licensesection pointing toLICENSE.package.json:repository.urlfrom SSH to HTTPS (npm convention;npm publishwarns on SSH URLs).filesallowlist (lib,CHANGELOG.md) so the published tarball excludes CI/governance files (.github/,.tartufo/,tartufo.toml,.jshintrc,.nvmrc,.npmrc,CODE_OF_CONDUCT.md,CONTRIBUTING.md,SECURITY.md). Allowlist > denylist (.npmignore) so future top-level files cannot accidentally leak into published versions.CHANGELOG.md: log the above under[Unreleased].npm pack --dry-runproduces 24 files, identical to the prior.npmignoreapproach.