Skip to content

Maintainer's Guide

Practical reference for anyone taking over or contributing to the maintenance of the Image Link Formatter module.

See also:

Project Resources

Resource URL
Project page https://www.drupal.org/project/image_link_formatter
Issue queue https://www.drupal.org/project/issues/image_link_formatter
Git repository https://git.drupalcode.org/project/image_link_formatter
Pipeline schedules https://git.drupalcode.org/project/image_link_formatter/-/pipeline_schedules
Documentation site https://project.pages.drupalcode.org/image_link_formatter/

Repository Default Branch

The default branch is currently 2.2.x. All merge requests, hotfix, and new features should target this branch unless working on a specific older release (e.g. 1.0.x).

When a new major or minor Drupal version requires breaking changes, a new branch (e.g. 3.0.x) is created from the current default.

Issue Queue

The project issue queue is at: https://www.drupal.org/project/issues/image_link_formatter

Issue types

Type When to use
Bug Something doesn't work as documented or expected
Feature request New capability that doesn't exist yet
Task Maintenance work: dependency updates, refactoring, CI fixes
Support request Usage questions from the community
Plan Larger discussions before implementation begins

Issue workflow

  1. New issues arrive with status Active
  2. Assign to yourself when actively working on it
  3. Create a fork and open a merge request referencing the issue number
  4. CI must pass before merge
  5. Close the issue when the MR is merged to the default branch

Creating a New Release

  1. Verify CI is green on the default branch (2.2.x) — all jobs must pass.
  2. Update CHANGELOG.md (if present) with a summary of changes since the last release.
  3. On drupal.org, click Add new release.
  4. Select the correct branch (e.g. 2.2.x) and fill in: - Version (e.g. 2.2.1) - Release notes summarizing bug fixes and new features
  5. Tag the release in Git: bash git tag 2.2.1 git push origin 2.2.1
  6. Verify the release appears on the project page and the packagist mirror picks it up.
  7. Consider announcing on Drupal Slack (#contrib) for significant releases.

Normalizing composer.json

After any edit to composer.json, run composer normalize to enforce consistent key ordering and formatting:

composer normalize

This uses the ergebnis/composer-normalize plugin (already present in composer.json). It prevents noisy diffs caused by different editors reordering keys inconsistently.

Tip

Make composer normalize part of your pre-commit habit whenever touching composer.json.

Maintainer Guide: Overview  ·  Getting Started  ·  CI/CD Pipeline  ·  Documentation & Tooling