Problem/Motivation

I've been maintaining my contrib projects using https://github.com/ddev/ddev-drupal-contrib for some time now, and have just been leaving the .ddev folder uncommitted (via ./git/info/exclude).

But now that DDEV has become the recommendation for Drupal local development, I feel it is now safe to commit the .ddev folder to the project (as recommended by ddev-drupal-contrib) and then document in the README.md how to setup a local environment for contribution/maintenance.

Optional. Commit the changes in the .ddev folder after this plugin installs. This saves other users from having to install this integration.

Other projects where .ddev has been committed.

https://git.drupalcode.org/project/og/-/tree/2.x?ref_type=heads
https://git.drupalcode.org/project/domain_perm/-/tree/2.0.x?ref_type=heads
https://www.drupal.org/project/svg_image_field/issues/3449084
https://www.drupal.org/project/date_filter/issues/3532384
https://www.drupal.org/project/calendar/issues/3518635
https://www.drupal.org/project/label_help/issues/3449755

Proposed resolution

  • Commit the .ddev/ folder and simplified config.yaml file
  • Since DDEV doesn't auto-install Drush anymore, add drush/drush to dev dependencies of the composer.json for standard cli tooling access. Note this module currently doesn't have any custom Drush commands, but it helps to have a fully functional DDEV local environment including drush, and it seems this is currently the only way.
  • Add CONTRIBUTING.md to document how to use DDEV Drupal Contrib and keep our dependencies up-to-date.
Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

joelpittet created an issue. See original summary.

joelpittet’s picture

Status: Active » Fixed

moved this up to support newer versions so I can test the `ddev install` script.

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.