Skip to content

Commit

Permalink
typo fix
Browse files Browse the repository at this point in the history
  • Loading branch information
rosanna-smith committed Sep 9, 2024
1 parent 529b41d commit 94b6165
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,18 @@

To preview a local host version of Crate-O do the following:

npm install .
`npm install .`

run npm dev
`npm run dev`

Open localhost URL in a compatible browser.

## Crate-O Release Process

To merge a branch to main and release a Crate-O update:

- Create a pull request on GitHub as normal, and assign someone as reviewer and assignee
- On the ticket, reviewer selects the __Files Changed__ tab to review the changes in the pull request. In the _package.json_ file, if the _version_ hasn't been updated, add a comment to the ticket for the creator to push this change:
<br>"Please update the version number in the package.json file. Increment last decimal by one, e.g. v0.3.13 -> v0.3.14"
- On the ticket, reviewer selects the **Files Changed** tab to review the changes in the pull request. In the _package.json_ file, if the _version_ hasn't been updated, add a comment to the ticket for the creator to push this change:
<br>"Please update the version number in the package.json file. Increment last decimal by one, e.g. v0.3.13 -> v0.3.14"
- Creator edits the version number on the branch and pushes change to the ticket
- If all other updates are fine, reviewer approves the merge.
- If all other updates are fine, reviewer approves the merge.

0 comments on commit 94b6165

Please sign in to comment.