Skip to content

Latest commit

 

History

History
76 lines (58 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

76 lines (58 loc) · 1.91 KB
Raw

Contribution Guide

Download, install, build, and test with:

git clone https://github.com/nucypher/taco-web
cd taco-web
pnpm install

Development

Execute common tasks with:

pnpm build
pnpm test
pnpm lint
pnpm fix

Documentation

Build and publish documentation with:

pnpm doc
pnpm doc:publish

Publishing

  1. Update version and create tags

For each package in the following order: shared, taco-auth, taco, do the following:

  • Update the version value in corresponding package.json
  • Commit the change using the following commit message:
chore(release): release @nucypher/<package>:<new_version>
  • Tag the commit
git tag <package>@<version>
  1. Push the commits, and the tags
git push orgin <branch> && git push origin shared@<new_version> && git push origin taco-auth@<new_version> && git push taco@<new_version>
  • NOTE: each <new_version> may be a different value
  1. Publish @nucypher/shared, @nucypher/taco-auth and @nucypher/taco packages to npm.

Perform a dry run to observe the eventual outcome without actually publishing

pnpm publish -r --filter '!@nucypher/pre' --dry-run

If the outcome looks good then re-run the command without the --dry-run parameter

pnpm publish -r --filter '!@nucypher/pre'

View resulting published versions:

  1. Tag latest release of @nucypher/taco for various domains where appropriate:
npm dist-tag add @nucypher/taco@<new_version> devnet
npm dist-tag add @nucypher/taco@<new_version> testnet
npm dist-tag add @nucypher/taco@<new_version> mainnet

where <new_version> is the latest version that was published.