korbeil/jane-v8

将所有 Jane 组件整合到一个仓库中

dev-main 2024-07-15 19:42 UTC

This package is auto-updated.

Last update: 2024-09-15 20:00:16 UTC


README

步骤

  • 解析器(文件/JSON > 数组)
  • 元数据(JSON > 元数据)
  • 编译器(元数据 > PHP 表示形式)
  • 生成器(PHP 表示形式 > 生成代码)

待办事项

JSON Schema ALPHA-1 之前

  • 修复 OneOf 固件
  • 在 JSON Schema 生成器中进行更多运行时测试
  • 从头开始编写文档(MkDocs)

文档

Jane 使用 Docsify 生成文档。在为 Jane 代码库做出贡献时,保持文档更新至关重要。

首先,您需要安装 Docsify

yarn global add docsify-cli

然后监视文档文件夹

docsify watch /docs

贡献

您可以为此仓库做出贡献。要获取代码的最新版本,请检出此仓库,然后

composer update

进行您的更改,在提交/创建拉取请求之前,您应该运行

composer cs-fix # will fix any coding style issue
composer cs-check # will check if you have any issue in your code thanks to PHPStan
composer tests # will run Jane's test suite

完成以上步骤后,您可以创建您的拉取请求。请始终考虑更新 CHANGELOG 文件,并添加与添加的功能相关联的测试或非回归测试(如果您正在修复错误)。