Skip to content

Latest commit

 

History

History
23 lines (14 loc) · 915 Bytes

README.md

File metadata and controls

23 lines (14 loc) · 915 Bytes
Raw

Crate-O Developer Documentation

Crate-O as a component

Basic Installation

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

npm install .

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:
    "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.