Contributing to Acquia BLT¶

Submitting issues¶

Select your issue type carefully, and if you are not sure of the issue type, the issue type is probably a support request.

• Feature request – A request for a specific enhancement for Acquia BLT. This is distinct from a bug report, as it indicates a missing feature for Acquia BLT functionality, instead of a literal error with Acquia BLT. Feature requests are distinct from support requests, in that they are specific and atomic requests for new Acquia BLT functionality, instead of a general request for help or guidance.

• Bug report – A clearly defined instance of Acquia BLT not behaving as expected. It is distinct from a feature request in that it represents a mismatch between what Acquia BLT does and what Acquia BLT claims to do. It is distinct from a support request by having specific steps to reproduce the problem (ideally starting from a fresh installation of Acquia BLT) and justification as to why this is a problem with Acquia BLT rather than an underlying tool, such as Composer or Drush.

• Support request – A request for help or guidance. Use this issue type if you are not sure how to do something or can’t find a solution to a problem that may or may not be a bug. Before filing a support request, review the FAQ for solutions to common problems and general troubleshooting techniques.

  If you have an Acquia subscription, consider filing a Support ticket instead of an Acquia BLT issue to receive support subject to your SLA.

After selecting your issue type, be sure to complete the entire issue template.

Newly-filed issues will be reviewed by an Acquia BLT maintainer. If additional information is requested and no reply is received within a week, issues may be closed.

Note the following when submitting issues:

• Issues filed directly to the Acquia BLT project are not subject to a service-level agreement (SLA).
• Acquia BLT is distributed under the GPLv2 license; all documentation, code, and guidance is provided without warranty.
• The project maintainers are under no obligation to respond to support requests, feature requests, or pull requests.

Submitting pull requests¶

Developing Acquia BLT locally¶

If you want to contribute by actively developing Acquia BLT, we recommend cloning Acquia BLT and also creating an Acquia BLT-based project for testing your changes.

Use the following commands to create a testable Acquia BLT-created project alongside Acquia BLT:

git clone https://github.com/acquia/blt.git
rm -rf blted8
composer install --working-dir=blt
cd blt
./vendor/bin/robo create:from-symlink

The new blted8 directory will have a Composer dependency on your local clone of Acquia BLT using a ../blt symlink. You can make changes to files in blt and see them immediately reflected in blted8/vendor/acquia/blt.

Testing¶

To complete the same release testing that is performed during continuous integration (CI) execution, run the following command:

./vendor/bin/robo release:test

Note that Acquia BLT version 10.x requires the following to run the same release testing performed during CI execution:

• Four local MySQL databases available, with drupal, drupal2, drupal3, and drupal4 as the db names.

• A MySQL user with access to the above, with drupal as the username and password. It may be sensitive to MySQL version. In newer versions of MySQL (8+), you may need to set the user password as follows:

  alter user 'drupal'@'localhost' identified with mysql_native_password by 'drupal';
  

• The PHP MySQL extension to be enabled.

• Chromedriver, sqlite, and the php-sqlite3 extension to run @group drupal tests.

• (Optional) Exclude @group requires-vm.