diff --git a/Release_Protocol.md b/Release_Protocol.md index 9f6362b26c..7d0507c38b 100644 --- a/Release_Protocol.md +++ b/Release_Protocol.md @@ -4,20 +4,24 @@ When it is time to release, use a pull request to put the repository into a rele allowing testing and edits prior to merging to master. The following procedure ensures a predictable release. +The protocol assumes that you have a [fork](https://help.github.com/en/articles/fork-a-repo) +of the bids-standard/bids-specification repository and have [cloned](https://help.github.com/en/articles/cloning-a-repository) +your fork locally to a directory called `bids-specification`. + ### 1. Fetch the latest version of the [master branch of the BIDS-specification](https://github.com/bids-standard/bids-specification/tree/master) -You should have a remote, which we will call `upstream`, for the [ -bids-standard/bids-specification](https://github.com/bids-standard/bids-specification/) repository: +You should have a remote, which we will call `upstream`, for the +[bids-standard/bids-specification](https://github.com/bids-standard/bids-specification/) +repository: ```Shell $ git remote get-url upstream git@github.com:bids-standard/bids-specification.git ``` -If you do not, clone the Master branch of the BIDS-specification and add it to `upstream` with: +If you do not, add it with: ```Shell -$ git clone https://github.com/bids-standard/bids-specification.git $ cd bids-specification $ git remote add upstream git@github.com:bids-standard/bids-specification.git ``` @@ -60,7 +64,7 @@ discrepancies is reduced. ```Shell $ git add src/CHANGES.md mkdocs.yml -$ git commit -m 'REL: v1.2.0` +$ git commit -m 'REL: v1.2.0' $ git push -u upstream rel/1.2.0 ```