README

Charcoal 是一个适应所有项目需求的网络框架和内容管理系统。

此仓库是一个包含整个网络框架的单仓库。Charcoal 可以用作全栈框架，也可以作为独立的包使用。

Charcoal 包

核心包位于 packages 目录。

安装

首选（也是唯一支持的）方法是使用 Composer

composer require charcoal/charcoal

从工作骨架开始

composer create-project charcoal/boilerplate

独立包

Charcoal 框架被分割成独立的包，可以独立使用。例如，一个项目可能不需要管理面板、队列系统或发送电子邮件。

composer require charcoal/app charcoal/api custom/admin 

将项目迁移到 charcoal/charcoal

以下内容将帮助将项目从 locomotivemtl/charcoal-* 转换为 charcoal/*。

ℹ️ 之前所有核心包都独立维护自己的版本号。

单仓库框架使用共享版本号，以确保所有核心包之间的一致性和预期的互操作性。

ℹ️ contrib 包继续维护其现有的独立版本号。

依赖项

⚠️ 必需的

• PHP 7.4 或 8.0

⚙️ 配置

[待办事项]

使用方法

[待办事项]

开发

开发在从 main 分支分离的分支上进行。

⚠️ main 分支是受保护的，不允许直接推送更改。

要安装开发环境

composer install

要运行脚本（phplint、phpcs 和 phpunit）

composer test

提交信息格式

Charcoal 使用 semantic-release 来处理发布过程。

它使用提交信息来确定代码库中更改的消费影响。遵循提交信息的正式化约定，semantic-release 自动确定下一个 语义版本 号码，生成变更日志并发布版本。

当前设置使用 Conventional Commits 用于提交信息。您可以参考它获取更多信息。

此存储库对 Commitizen 友好，并配置为使用 Conventional Commits 标准，因此您可以全局安装它以简化编写提交的过程。

或者，有一些代码编辑器插件可以帮助创建常规提交

• vscode
  • VSCode Conventional Commits
• phpstrom
  • Conventional Commit
  • Git Commit Template

以下是一些基于提交信息的发布类型示例

• 修补（修复）版本发布

  fix(pencil): stop graphite breaking when too much pressure applied

• 次要（功能）版本发布

  feat(pencil): add 'graphiteWidth' option

• 主要（破坏性）版本发布

  perf(pencil): remove graphiteWidth option
  
  BREAKING CHANGE: The graphiteWidth option has been removed.
  The default graphite width of 10mm is always used for performance reasons.

  ✍🏻 注意，BREAKING CHANGE: 标记必须位于提交的底部。

开发指南

开发应该是基于分支的，提交信息应遵循 Conventional Commits。

维护和自动化

Symplify的MonorepoBuilder用于处理核心仓库与其包之间的一致性。它将同步composer.json文件和包版本。

[待办事项] 在.releaserc中配置语义发布

[待办事项] Conventional Commits

[待办事项] Commitizen

开发依赖

• symplify/monorepo-builder
  • 保持包版本同步。
  • 配置位于monorepo-builder。它允许定义更多的依赖项
• semantic-release
  • 通过Github action处理发布过程。

开发历史

此单例仓库是用此指南和工具以多对单的方法创建的

• hraban/tomono

Github Actions

脚本

create-pr

此脚本简化了创建Pull Request的过程。当你的分支准备好被拉入main或另一个[目标]分支时，这个工具会为你生成它，请求@charcoalphp/reviewers进行审查，并添加一个从两个分支之间的差异生成的美观且易于阅读的发布说明。

文档

Description
  Create a pull request on the github repository on the requested branch.
  Default branch: main

Usage
  ./create-pr

Options
  -b, --base          The base branch to merge into for the pull request. [Default: main]
  -h, --head          The branch to compare against the base branch. [Default: The current branch]

示例

# target: the target branch for the pull request. Defaults to [main]
./create-pr -b main -h user:feat-branch

create-release-notes (可选工具)

此脚本根据请求生成发布说明，返回基于请求的提交范围或分支的变更日志。

文档

./build/script/create-release-notes --help

示例

./build/script/create-release-notes -g --from main

输出

更改

特性

• create-pr: 添加一个脚本以在远程触发拉取请求（《3016115）

错误修复

• create-pr: 从脚本中移除个人访问令牌，并用$GITHUB_TOKEN代替（《f2aaac6）
• 包: 添加缺失的 semantic-release 插件 (59bd1b1)

贡献

与 Charcoal 互动的每个人都被期望遵循 行为准则。

请参阅我们的 贡献指南 了解如何为 Charcoal 做出贡献。

如果您正在尝试报告 Charcoal 中可能的安全漏洞，请参阅我们的 安全策略 获取更多信息。

✍🏻 作者

• Locomotive 🚂
• Mathieu Ducharme 👨🏻‍💻
• Chauncey McAskill 👨🏻‍💻
• Joel Alphonso 👨🏻‍💻
• Dominic Lord 👨🏻‍💻
• Benjamin Roch 👨🏻‍💻

🎉 贡献者

Made with contrib.rocks.

变更日志

查看 CHANGELOG。

变更日志符合 Keep a Changelog 规范，并从自动发布中自动生成。

许可

Charcoal 采用 MIT 许可证。有关详细信息，请参阅 LICENSE。