CONTRIBUTING.md

Contributing

1. Fork this repo and clone it to your development computer.
2. From the terminal, navigate to the directory for your cloned repo.
3. Add the main repo as a remote named upstream

   git remote add upstream https://github.com/notaryproject/notaryproject.dev.git

4. Use nvm to install the latest [LTS release][] of Node.

   nvm install --lts

5. Use npm to get NPM packages and install the git submodules.

   npm install

   Note By default, this is done on the origin/main branch. This step must be performed on a branch based from origin before you start creating new branches based on upstream/main. If you skip this step, the submodules will fail to install correctly.

Build or serve the site

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

Submitting a PR

1. Fetch the latest from upstream and create a new branch for your change.

   git fetch upstream
   git checkout -b <branch_name> upstream/main

2. Make your changes.
3. Build and test the site on your development computer to verify your changes appear as you intended.
4. 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.
5. Commit and push your changes. Note that Notary project repositories require signed commits. You can refer to GitHub documentation on commit signatures verification to know more about signing commits.

   git add <files_changed>
   git commit -m <commit_message>
   git push origin HEAD

6. File a PR to notaryproject.dev.

Updating project maintainers

1. Ensure justification is provided for the change. Example
2. Create a PR that updates both CODEOWNERS and MAINTAINERS with the maintainer updates. Example
3. Make sure @notaryproject/notaryproject-governance-maintainers is added as a reviewer.