- Fork this repo and clone it to your development computer.
- From the terminal, navigate to the directory for your cloned repo.
- Add the main repo as a remote named
upstream
git remote add upstream https://github.com/notaryproject/notaryproject.dev.git
- Use
nvm
to install the latest [LTS release][] of Node.nvm install --lts
- Use
npm
to get NPM packages and install the git submodules.NOTE: By default, this is done on thenpm install
origin/main
branch. This step must be performed on a branch based fromorigin
before you start creating new branches based onupstream/main
. If you skip this step, the submodules will fail to install correctly.
To locally serve the site at [localhost:8888][], run the following command:
$ npm run serve
To build and check links, run these commands:
$ npm run build
$ npm run check-links
- Fetch the latest from
upstream
and create a new branch for your change.git fetch upstream git checkout -b <branch_name> upstream/main
- Make your changes.
- Build and test the site on your development computer to verify your changes appear as you intended.
- If you updated any CLI commands, manifest examples, or code/configuration examples, please test those changes as well to ensure they work as you intended.
- Commit and push your changes.
git add <files_changed> git commit -m <commit_message> git push origin HEAD
- File a PR to notaryproject.dev.