开源项目 `public-conventions` 使用教程

开源项目 public-conventions 使用教程

public-conventions In-house conventions and styles 项目地址: https://gitcode.com/gh_mirrors/pu/public-conventions

1. 项目的目录结构及介绍

public-conventions 项目的目录结构如下：

public-conventions/
├── .circleci/
│   └── config.yml
├── conventions/
│   ├── css.md
│   ├── django.md
│   ├── emoji_shorthand.md
│   ├── git.md
│   ├── graphql.md
│   ├── html_django_templates.md
│   ├── python.md
│   ├── python_architecture_patterns.md
│   ├── pull_requests.md
│   ├── terraform.md
│   └── testing.md
├── .markdownlint.yaml
├── .prettierignore
├── .prettierrc.yaml
├── .spelling
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── git.md
├── makefile
└── package.json

目录结构介绍

• .circleci/: 包含 CircleCI 的配置文件 config.yml，用于持续集成和持续部署。
• conventions/: 包含各种编程语言和技术的编码规范和最佳实践文档。
  • css.md: CSS 编码规范。
  • django.md: Django 框架的编码规范。
  • emoji_shorthand.md: 代码审查和 Slack 消息中使用的表情符号简写。
  • git.md: Git 使用规范。
  • graphql.md: GraphQL 编码规范。
  • html_django_templates.md: HTML 和 Django 模板编码规范。
  • python.md: Python 编码规范。
  • python_architecture_patterns.md: Python 架构模式。
  • pull_requests.md: 拉取请求（Pull Requests）规范。
  • terraform.md: Terraform 编码规范。
  • testing.md: 测试规范。
• .markdownlint.yaml: Markdown 格式检查配置文件。
• .prettierignore: Prettier 忽略文件配置。
• .prettierrc.yaml: Prettier 格式化配置文件。
• .spelling: 拼写检查配置文件。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• README.md: 项目介绍和使用说明。
• git.md: Git 使用规范。
• makefile: Makefile 文件，用于自动化构建和测试。
• package.json: Node.js 项目的配置文件。

2. 项目的启动文件介绍

public-conventions 项目本身是一个文档集合，没有传统的启动文件。项目的主要目的是提供编码规范和最佳实践的文档，供开发者参考和遵循。

3. 项目的配置文件介绍

.circleci/config.yml

CircleCI 的配置文件，定义了项目的持续集成和持续部署流程。

.markdownlint.yaml

Markdown 格式检查配置文件，用于确保文档的格式一致性。

.prettierignore

Prettier 忽略文件配置，指定哪些文件或目录不需要进行代码格式化。

.prettierrc.yaml

Prettier 格式化配置文件，定义了代码格式化的规则。

.spelling

拼写检查配置文件，用于检查文档中的拼写错误。

CONTRIBUTING.md

贡献指南，指导开发者如何为项目做出贡献。

LICENSE

项目许可证，定义了项目的开源许可协议。

README.md

项目介绍和使用说明，提供了项目的概述和使用指南。

makefile

Makefile 文件，用于自动化构建和测试。

package.json

Node.js 项目的配置文件，定义了项目的依赖和脚本。

---

以上是 public-conventions 项目的使用教程，希望对你有所帮助。

public-conventions In-house conventions and styles 项目地址: https://gitcode.com/gh_mirrors/pu/public-conventions