README

A Drupal distribution and installation profile designed to help UK and Irish councils collaborate and share Drupal code and build a culture of publishing excellent website content for everyone.

This project is the Drupal installation profile that is best installed using composer to require a project template, localgov_project, to scaffold and build the codebase, which includes this installation profile.

支持的分支

We are actively developing and supporting the 3.x branch for Drupal 10.

The 2.x branch is no longer officially supported, as Drupal 9 is unsupported since 1st November 2023. We will continue to help our councils that have not yet upgraded to Drupal 10, on a best efforts basis.

The 1.x branch is no longer actively supported and not recommended for new sites.

重要: If you are still using the 1.x or 2.x branches on your site, please create an issue on Github to let us know.

文档

更多针对开发者、内容设计师和其他受众的文档可以在 https://docs.localgovdrupal.org/ 找到。

本地安装LocalGov Drupal的测试和开发需求

要本地安装LocalGov Drupal，您需要适当版本的

PHP（请参阅 https://www.drupal.org/docs/system-requirements/php-requirements）
数据库服务器，如MySQL（请参阅 https://www.drupal.org/docs/system-requirements/database-server-requirements）
网络服务器，如Apache2（请参阅 https://www.drupal.org/docs/system-requirements/web-server-requirements）

我们许多人使用包含的Lando文件来运行本地Docker环境进行测试和开发，但有些人更喜欢在主机机器上直接运行网络服务器。

我们还为喜欢DDEV的开发者提供了默认的DDEV配置。

PHP需求

我们遵循Drupal的PHP建议：https://www.drupal.org/docs/system-requirements/php-requirements#versions

我们目前推荐PHP 8.1，并旨在支持PHP 8.2，与Drupal 10的PHP支持保持一致。

您还需要启用某些PHP扩展（请参阅 https://www.drupal.org/docs/system-requirements/php-requirements#extensions），包括

PHP mbstring
PHP cURL
GD库
XML

如果在运行composer require时看到错误，请检查您的PHP扩展。

Composer和Lando

为了本地安装，您需要Composer，我们建议使用Lando以创建一致的开发环境。

请参阅Lando要求部分以获取不同操作系统的Docker要求详情。

https://docs.lando.dev/basics/installation.html#system-requirements

使用Composer本地安装LocalGov Drupal

要为测试或开发本地安装LocalGov Drupal，请使用基于Composer的项目模板。

将 MY_PROJECT 修改为您希望项目目录名称。

composer create-project localgovdrupal/localgov-project:^3.0 MY_PROJECT --no-install

进入 MY_PROJECT 目录并运行 lando start。

cd MY_PROJECT
lando start

一旦 lando 构建完成，使用 lando 运行 composer install 和站点安装程序。

lando composer install
lando drush si localgov -y

注意：由于您的主机机器上可能运行的是与 Lando 运行版本不同的 PHP 版本，因此建议在 Lando 中运行 composer install。这确保了依赖项反映了实际运行的 web 服务器上的 PHP 版本。

Composer 注意事项

如果您在本地上开发，并希望强制 composer 从源代码克隆而不是使用 composer 缓存，可以添加 --no-cache 标志。

composer create-project localgovdrupal/localgov-project:^3.0 MY_PROJECT --no-cache  --no-install

如果您只想拉取 LocalGov Drupal 的最新更改，请使用 --no-cache 标志运行 composer update。

lando composer update --no-cache

如果您想在开发过程中确保获取最新的提交，清除 composer 缓存、删除文件夹并重新运行 composer update 似乎是一个可行的做法。

rm -rf web/profiles/contrib/ web/modules/contrib/ web/themes/contrib/;
composer clear-cache; composer update --with-dependencies --no-cache;
lando start;
lando drush si localgov -y;

如果在运行 Composer 命令时遇到内存限制错误，请在命令前添加 COMPOSER_MEMORY_LIMIT=-1。例如，要安装项目，请运行

COMPOSER_MEMORY_LIMIT=-1 composer create-project localgovdrupal/localgov-project:^3.0 MY_PROJECT

贡献

有关当前贡献指南，请参阅 CONTRIBUTING.md。

问题跟踪

在早期开发阶段，大多数问题将在这个存储库中跟踪 https://github.com/localgovdrupal/localgov/issues。

与特定项目或模块相关联的开发问题应在项目存储库中跟踪。将来，我们可能会为终端用户集中跟踪错误报告设置单独的存储库。

开发设置

目前使用的最主要开发环境是 Lando - 一个基于 Docker 的开发环境，适用于 Linux、MacOS 和 Windows。

@todo 记录 Lando 设置。

编码标准

Composer 将 PHP CodeSniffer 作为开发依赖项安装，并配置为使用 Drupal 编码标准和最佳实践。在提交任何代码之前运行这些标准是个好主意。所有拉取请求中的代码都应该通过所有 CodeSniffer 测试。

要使用 Lando 检查代码，请运行

lando phpcs

要尝试在 Lando 中自动修复编码错误，请运行

lando phix

编码标准资源

Drupal 编码标准

运行测试

包含的 phpunit.xml.dist 文件包含自动运行 LocalGov Drupal 测试套件的配置。

要使用 Lando 运行所有 LocalGov Drupal 测试，请使用

lando phpunit

要运行特定模块的所有测试，请使用

lando phpunit web/modules/contrib/localgov_my_module

可以使用 --filter 选项过滤测试。要仅运行特定测试，请使用

lando phpunit --filter=myTestName

测试资源

安全策略

拥有一种安全且安全地报告安全问题的方法非常重要。幸运的是，Drupal 多年来在这方面做得很好，通过安全团队。我们在 drupal.org 上发布我们的分发，并选择加入安全通告策略。

查看 https://www.drupal.org/drupal-security-team/general-information

如何报告安全问题

如果您发现或了解到可能影响Drupal、LocalGov Drupal或LocalGov Drupal Microsites安全性的错误、弱点或威胁，我们要求您对此保密，并通过以下链接提交您的担忧给Drupal安全团队。

维护者

此项目目前由以下人员维护：

Andy Broomfield: https://www.drupal.org/u/andybroomfield
Ekes: https://www.drupal.org/u/ekes
Finn Lewis: https://www.drupal.org/u/finn-lewis
Maria Young: https://www.drupal.org/u/mariay-0
Mark Conroy: https://www.drupal.org/u/markconroy
Stephen Cox: https://www.drupal.org/u/stephen-cox

localgovdrupal / localgov

维护者

详细信息