Skip to content

Pull requests

When submitting a pull request, titles should begin with a descriptive prefix (e.g., "[ENH] Implement check for presence of a session ID column").

  • [ENH]: Feature improvements or additions
  • [REF]: Refactoring existing code
  • [TST]: Updating or adding a test
  • [CI]: Automation-related changes
  • [MNT]: General maintenance not covered by [REF], [TST], or [CI]
  • [INF]: Software or graph infrastructure-related changes
  • [FIX]: Bug fixes
  • [MODEL]: Updates or changes related to the Neurobagel data model
  • [DOC]: Documentation-only changes to a code repo (READMEs, within-code documentation, etc.) Note: do not use for changes to the neurobagel/documentation repo. See below for PR prefixes for the documentation repo.

Changes to documentation pages

In PRs for the Neurobagel documentation, using the [DOC] title prefix is discouraged as it is too broad. Instead, for documentation content changes, the following prefixes can be used to specify the nature of the change:

  • [ENH]: Updating or adding new documentation
  • [REF]: Simplifying or restructuring documentation (i.e., pages, sections, paragraphs)
  • [FIX]: Fixing errors in the documentation

Pull request reviews

A core maintainer will review each PR and may provide comments or suggestions for the PR author to address.

Neurobagel PR reviews may use the following emoji signifiers:

🧑‍🍳: Ready to merge or approved without suggestions

🍒: Some optional/suggested changes that could be nice to have but are not required to merge

If (required) changes are requested, the PR author should re-request a review from the reviewer once the comments have been addressed.

When your pull request is approved

If you are not a member of the Neurobagel developer team: the reviewing Neurobagel maintainer is responsible for merging the PR.

If you are a member of the Neurobagel developer team (i.e., you have write access to the repository): the PR author is responsible for merging the PR.