Update CONTRIBUTING.md

Created on 14 April 2025, 11 days ago

Overview

The documentation is outdated. CONTRIBUTING.md is still saying that Drupal 10.4 is accepted and the presence of the ddev-drupal-xb-dev is not strong enough, in my opinion.

Proposed resolution

  1. Update the CONTRIBUTING.md file, explaining first how to set up the XB project with the ddev addon.
  2. Explain a bit the commands provided by the ddev-drupal-xb-dev addon to help developers use phpcs, phpcsf phpstan, phpunit,...
📌 Task
Status

Active

Version

0.0

Component

Documentation

Created by

🇪🇸Spain isholgueras

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @isholgueras
  • 🇪🇸Spain isholgueras

    I've updated the README.md and the CONTRIBUTING.md to match the new requirements (Drupal >= 11.1.2) and to include better information about the ddev-drupal-xb-dev ddev addon.

    What I don't know is if we should include sections like:

    1. Prerequisites: to include it requires php8.3, Drupal 11.1.2, ...
    2. Code structure overview: To explain how's the code structure (tests, tests modules, ui, ...)
    3. Contribution workflow: I assume this is implicit in any Drupal contribution, but we can add a specific section about the usage of phpunit, phpstan, ... It's, more or less, added to both sections, but maybe something clearer.
    4. Development best practices: Besides of the "use dependency injection,..." type of things, practices or contracts made in this specific project. Maybe like ADRs but not that strict.
    5. Links to other projects related with XB?

    Any other thing to add things to add?

  • Merge request !897Issue #3518999: Update documentation. → (Merged) created by isholgueras
  • Pipeline finished with Success
    10 days ago
    Total: 998s
    #473138
  • Pipeline finished with Failed
    9 days ago
    Total: 1280s
    #474070
  • 🇧🇪Belgium wim leers Ghent 🇧🇪🇪🇺

    Checked with the team working full-time on XB, and we're 50/50 on ddev vs "bare metal" on macOS.

    Given that, we can be confident enough about recommending ddev. That was my key reservation.

    Thanks for making these docs more welcoming, @isholgueras! 🙏🥳

  • Pipeline finished with Skipped
    2 days ago
    #479366
  • Pipeline finished with Skipped
    2 days ago
    #479367
  • 🇧🇪Belgium wim leers Ghent 🇧🇪🇪🇺
Production build 0.71.5 2024