Contributing
============
.. include:: ../CONTRIBUTING.md
:parser: myst_parser.sphinx_
Commit Message Guidelines
--------------------------
This project uses `Conventional Commits ():
Types
~~~~~
- ``feat``: A new feature (triggers MINOR version bump)
- ``fix``: A bug fix (triggers PATCH version bump)
- ``docs``: Documentation only changes
- ``style``: Changes that don't affect code meaning (formatting, etc.)
- ``refactor``: Code change that neither fixes a bug nor adds a feature
- ``perf``: Performance improvements
- ``test``: Adding or updating tests
- ``build``: Changes to build system or dependencies
- ``ci``: Changes to CI configuration files and scripts
- ``chore``: Other changes that don't modify src or test files
Breaking Changes
~~~~~~~~~~~~~~~~
Add ``!`` after the type or ``BREAKING CHANGE:`` in the footer to trigger
a MAJOR version bump:
.. code-block:: text
feat!: remove deprecated API endpoint
BREAKING CHANGE: The /api/v1/old endpoint has been removed.
Use /api/v2/new instead.
Examples
~~~~~~~~
**Feature Addition:**
.. code-block:: text
feat(preprocessing): add support for multi-echo fMRI
Implement multi-echo fMRI preprocessing workflow with optimal
combination of echoes using tedana.
**Bug Fix:**
.. code-block:: text
fix(fieldmap): correct IntendedFor field mapping
Fix issue where fieldmap IntendedFor fields were not properly
updated for runs with non-sequential numbering.
Fixes #123
**Documentation:**
.. code-block:: text
docs: update configuration guide with new parameters
Add documentation for FMRIPREP_OUTPUT_SPACES and clarify
fieldmap mapping syntax.
**Breaking Change:**
.. code-block:: text
feat!: update to fMRIPrep 24.0.0
BREAKING CHANGE: Update to fMRIPrep 24.0.0 which requires
different output space syntax. Update settings.template.sh
accordingly.
Scope
~~~~~
Optional, but recommended. Common scopes include:
- ``preprocessing``
- ``fieldmap``
- ``config``
- ``workflow``
- ``docs``
- ``ci``
Release Process
---------------
Releases are automated using GitHub Actions. When commits are pushed to the
main branch:
1. The workflow analyzes commit messages
2. Determines the appropriate version bump (MAJOR, MINOR, or PATCH)
3. Generates a changelog from commits
4. Creates a Git tag
5. Publishes a GitHub release
Manual Release
~~~~~~~~~~~~~~
To manually trigger a release with a specific version bump:
1. Go to Actions → Release workflow
2. Click "Run workflow"
3. Select the version bump type (major, minor, or patch)
4. Click "Run workflow"
Version Numbering
~~~~~~~~~~~~~~~~~
This project follows `Semantic Versioning