集合证据报告

提供为 Polkadot 链上集合创建证据报告的方法。报告是机器可读的，并可渲染。这只是一个建议的格式 - 不必按照这种方式进行。

工作证据的渲染 HTML/PDF 输出可能如下所示

或集体加入请求

创建证据 - 手动

此存储库的主要部分是 架构 文件。它提供了一个指南，说明在系统集合的工作报告中应提供哪些信息。

最简单的方法是复制 模板 并手动填写。就这样，无需 CLI！尽管没有编辑器支持和验证，这将很困难。

如果您想要编辑器支持和字段自动完成，则可以下载 架构 文件并在您的编辑器中配置它。下面以 VsCode 为例进行说明。
有一个 validate evidence 子命令可用于检查证据文件是否符合架构。

VS Code 架构集成

打开您的 settings.json 文件并插入以下内容，或扩展此部分。您需要将路径替换为架构的路径。这只是一个示例

"yaml.schemas": {
	"/Users/oliver/Documents/work/collective-cli/schema/potoc.evidence_report.json": "*.evidence",
},
 "files.associations": {
	"*.evidence": "yaml",
},

创建证据 - 交互式

您可以按如下方式安装 CLI

cargo install --git https://github.com/super-collective/collective-cli

运行 collective new evidence 将提示您几个基本问题。这些问题将存储在配置文件中，并在下一次运行时可用。

渲染证据

CLI 可以将 .evidence 文件转换为 HTML。还可以使用以下方法将 HTML 文件进一步转换为 PDF。

# https://github.com/michaelrsweet/htmldoc
htmldoc --webpage -f example/example.pdf example/example.html
# https://github.com/ilaborie/html2pdf
html2pdf example/example.html

创建请求准入 - 交互式

有一个 new join-request 子命令，您可以使用它来创建请求准入。还可以手动填写或修改 示例文件。目前还没有为其定义模式，所以唯一验证它的方法是用 check join-request --files ..。

这应该在您的集体 join_request/ 目录中创建一个文件。您也可以使用 render join-request .. 将其转换为 HTML。

待办事项

• 为 join_request 添加模式。
• 添加端到端测试。第一次尝试没有在交互式 CLI 中工作，请参阅 测试。

许可证

GPL-3.0-only，请参阅 LICENSE。