-
Notifications
You must be signed in to change notification settings - Fork 16
chore/doc: Revert main to stable schema, update docs to explain branching #101
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
effigies
merged 7 commits into
bids-standard:main
from
effigies:doc/contributing-main-dev
Nov 11, 2024
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
6a9b52f
doc: Add guide to targeting main and dev branches
effigies 06f50b7
chore: Revert to stable schema on main
effigies a8b74af
chore(ci): Disable dwi_deriv on main branch
effigies 2ace302
chore(ci): Output debug info to assist in developing workflows
effigies bc3fe72
chore(ci): Enable unreleased examples on dev and PRs to dev
effigies 1325d9a
Apply suggestions from code review
effigies da30ada
chore: Update bids-examples
effigies File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -102,6 +102,65 @@ consider: | |
| - first checkout your main: `git checkout main` | ||
| - then run: `git reset --hard upstream/main` | ||
|
|
||
| ## Developing for the validator | ||
|
|
||
| When proposing a feature or bug fix, you must decide which branch you will target: | ||
| `main` or `dev`. | ||
| In most cases you will want `main`, but read below to understand the purposes of | ||
| the two branches. | ||
|
|
||
| ### Branching policy | ||
|
|
||
| The BIDS Validator's `main` branch tracks the most recent release version of the specification: | ||
| <https://bids-specification.readthedocs.io/en/stable/>. | ||
| Pull requests made against the `main` branch should implement features or fix bugs in a way | ||
| that preserves consistency with the stable specification. | ||
|
|
||
| The `dev` branch is for features that are not yet in the released version of the BIDS | ||
| specification. | ||
| The purpose of this branch is to verify that proposed rules can be validated and | ||
| provide users with preview access to upcoming changes to the validator, increasing the chances | ||
| of catching issues with the specification or the validator, prior to release. | ||
| Changes to the `dev` branch may be reverted at any time. | ||
|
|
||
| ### How to prepare a pull request for your target branch | ||
|
|
||
| If you're going to target `main`, then start as follows: | ||
|
|
||
| ```console | ||
| git fetch upstream | ||
| git switch -c feat/short-desc upstream/main | ||
| ``` | ||
|
|
||
| This will create a new branch named `feat/short-desc` | ||
| (use `fix/...` for bug-fix branches, `doc/...` for documentation, etc.) starting | ||
| from the current state of the `main` branch on the `upstream` remote. | ||
| Instead of `short-desc`, use a few words to make the content of your branch | ||
| easily identifiable. | ||
|
|
||
| Once you have changes committed and ready for review you can run: | ||
|
|
||
| ```console | ||
| git push -u origin feat/short-desc | ||
| ``` | ||
|
|
||
| GitHub will then give you a link such as: | ||
| <https://github.com/bids-standard/bids-validator/compare/master...username:bids-validator:feat/short-desc?expand=1>. | ||
| Follow that link to create a pull request. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I feel like the tense should match the sentence above the link. But when I tried rewording it, it didn't make me feel better. |
||
|
|
||
| While you are creating the pull request, verify that the base branch is set to `main`. | ||
|
|
||
| For `dev`, the process is identical: | ||
|
|
||
| ```console | ||
| git fetch upstream | ||
| git switch -c feat/short-desc upstream/dev | ||
| # Add your feature | ||
| git push -u origin feat/short-desc | ||
| ``` | ||
|
|
||
| Open PR, set base branch to `dev`. | ||
|
|
||
| [link_git]: https://git-scm.com/ | ||
| [link_handbook]: https://guides.github.com/introduction/git-handbook/ | ||
| [link_swc_intro]: http://swcarpentry.github.io/git-novice/ | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,7 +24,7 @@ | |
| }, | ||
| "imports": { | ||
| "@ajv": "npm:[email protected]", | ||
| "@bids/schema": "jsr:@bids/[email protected].4-dev.10+436d7cde", | ||
| "@bids/schema": "jsr:@bids/[email protected].3+2", | ||
| "@cliffy/command": "jsr:@effigies/[email protected]", | ||
| "@cliffy/table": "jsr:@effigies/[email protected]", | ||
| "@hed/validator": "npm:[email protected]", | ||
|
|
||
Submodule bids-examples
updated
18 files
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.