通过
搜索
搜索graze / 规范
Graze 编码规范
v2.0.5
2020-08-18 15:43 UTC
Requires (Dev)
This package is auto-updated.
Last update: 2024-08-29 04:03:30 UTC
README
此文档也以 mkdocs 格式提供。
本文件描述了 Graze 在其常用语言中的编码规范，由 Graze 技术团队执行和遵守。任何违反规范的行为必须由开发者证明合理，在不可避免的情况下（如第三方集成）可以允许例外。
本文件中的关键词“必须”、“禁止”、“必需”、“应”、“不应”、“建议”、“可能”、“可选”的解释方式参照 RFC 2119。
一般
- 缩进大小必须是4个空格字符，不能是制表符。
- 所有文件都必须以一个空白换行符（换行符）结尾。
- 所有文件都必须使用 Unix LF（换行）行结束符。
- 不允许有尾随空格。
Git
- 仓库名称应全部小写，并在适当的位置使用连字符（-）分隔单词。
- 内部库应使用“graze-”作为前缀。
- 建议遵循agis-/git-style-guide中维护的风格指南。
语言
开源
环境
视觉
开发
您可以通过调用以下命令来测试 mkdocs：
make docs-test
这将启动一个在端口 8000 上的 docker 开发服务器。