Merge pull request #145 from Language-Research-Technology/readme

release process added

README.md

@@ -9,14 +9,20 @@ Crate-O is a browser-based editor for  Research Object Crates  [(RO-Crate)](http
 - annotate existing resources elsewhere on the web
 - import bulk metadata from an Excel spreadsheet
 <!---End--->
-For more technical information on Crate-O, refer to the [Developer Documentation page](./docs)
 <!---Start--->
 NOTE: Crate-O is for Google Chrome and related browsers ONLY at this stage as it describes files on the users computer, and saves RO-Crate metadata there. We will be releasing a version that can be deployed as part of a service that accesses online resources directly, which will be compatible with other browsers (see the [Roadmap](https://github.com/Language-Research-Technology/crate-o#roadmap--backlog)).
 
 While the current version of Crate-O  is designed for editing self-contained RO-Crates (and works fine with crates containing tens of thousands of entities) - our roadmap includes editing fragments of larger linked-data resources, and integration with Arkisto repositories such as the [Oni](https://github.com/Language-Research-Technology/oni) repository, data API & search portal.
 
 Crate-O is currently developed by the Language Data Commons of Australia [(LDaCA)](https://www.ldaca.edu.au/), under the guidance of Peter Sefton as technical lead. If the tool is adopted in other contexts (we are in talks with a few groups about this)  then we aim to establish a steering committee / reference group to help guide development.
 <!---End--->
+
+# Developer Documentation
+
+For more technical information on Crate-O processes, refer to the [Developer Documentation](./docs).
+
+<br>
+
 # History
 
 Crate-O was is a rewrite of a tool called [Describo]. Though members of the Crate-O tool were involved in its conception, funding and development we are no longer associated with that line of development.

docs/README.md

@@ -10,4 +10,13 @@ npm install .
 
 run npm dev
 
-Open localhost URL in a compatible browser.
+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"
+- Creator edits the version number on the branch and pushes change to the ticket
+- If all other updates are fine, reviewer approves the merge.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "crate-o",
-  "version": "0.3.14",
+  "version": "0.3.15",
   "description": "A VueJS UI component to create and edit Research Object Crate (RO-Crate) metadata",
   "keywords": [
     "RO-Crate",
@@ -18,7 +18,7 @@
     "Alvin Sebastian (https://orcid.org/0000-0002-9086-1722)",
     "Moises Sacal Bonequi (https://orcid.org/0000-0002-4438-2755)",
     "Peter Sefton (https://orcid.org/0000-0002-3545-944X)",
-    "Rosanna Smith"
+    "Rosanna Smith (https://orcid.org/0009-0006-2241-3377)"
   ],
   "files": [
     "dist",