docs: fix leftover template-repos-ts-sol name in package.json and README - #432
Open
Jah-yee wants to merge 1 commit into
Open
docs: fix leftover template-repos-ts-sol name in package.json and README#432Jah-yee wants to merge 1 commit into
Jah-yee wants to merge 1 commit into
Conversation
This repository was scaffolded from the `template-repos-ts-sol` template but the package metadata and README title were never updated to reflect the actual purpose (Dev Protocol treasury contracts). This commit: - Updates `package.json` `name` from `template-repos-ts-sol` to `@devprotocol/treasury` and rewrites the description. - Adds the missing `repository`, `author`, and removes duplicate `author`/`license` fields. - Rewrites the README so the title matches the repository name and adds a short description and the available scripts.
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.
Summary
This repository was scaffolded from the
template-repos-ts-soltemplate, but the package metadata and README title were never updated to reflect the actual purpose (Dev Protocol treasury contracts). This PR fixes that.Changes
package.jsonname:template-repos-ts-sol→@devprotocol/treasurydescription:Template repository for using TypeScript and Solidity→Treasury contracts for the Dev Protocol ecosystemrepository,author, andlicenseat the top levelauthor: ""andlicensefields at the bottom of the file (which were previously dead overrides of the canonical top-level values)README.md# template-repos-ts-sol→# Treasuryyarnscripts (generate,test,build,lint)Why
The current
package.jsonnameand README title still showtemplate-repos-ts-sol, which is misleading for anyone browsing the published package or the repo. The repo ships under@devprotocol/*namespace and references@devprotocol/protocoland@devprotocol/protocol-v2as dependencies, so the package name should match.Search confirms the same leftover pattern exists in several other repos in the organization (e.g.
discord-market,i-s-tokens), so this is a known template-derivation issue. This PR is scoped totreasuryonly.Risk
Documentation and metadata only — no code changes, no CI changes, no dependency updates. The CI workflow and
hardhatconfig are untouched.