Skip to content

Commit 8bb0cdd

Browse files
committed
Update CONTRIBUTING with schema tag instructions
Closes #538
1 parent e3575c8 commit 8bb0cdd

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,13 @@ We release `bids-examples` in sync with `bids-specification`.
6969
configured as a git remote called "upstream")
7070
1. Tag the `master` branch: `git tag -a -m "X.X.X" X.X.X upstream/master`
7171
(replace `X.X.X` with the version to be released)
72-
1. Push the tag upstream: `git push upstream X.X.X`
72+
1. Make a schema tag: `git tag -a -m "BIDS Schema Y.Y.Y" schema-Y.Y.Y upstream/master`
73+
(replace `Y.Y.Y` with the version to be released)
74+
1. Push the tags upstream: `git push upstream --tags`
75+
1. Create a maintenance branch to track changes induced by updates to the
76+
validator or schema: `git push upstream upstream/master:refs/heads/maint/X.X.X`
77+
This branch allows for future schema releases on the corresponding specification
78+
branch, without accumulating datasets with new features.
7379
1. Create a GitHub release using the new tag. Fill the title of the release
7480
with the name of the tag. Fill the description of the release with a sentence like
7581
> "Microscopy" BEP was merged into BIDS-specification (2022-02-15).

0 commit comments

Comments
 (0)