文章目录
- 一：Pycharm 自动创建文件头部
- 二：代码门禁
- 三 ：CommitAngular规范
一：Pycharm 自动创建文件头部
- Pycham —> Preferences —> 编辑器 —> 文件和代码模版 —> 文件 —> Python Script —> 填写头部
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Time : ${DATE} ${TIME}
# @Author : shanwen.ren
# @Notice : Please use pre-commit to format before submitting
- 如下图所示：
- 创建文件时， 如下图所示， 自动生成头部
二：代码门禁
- 需求：提交代码之前， 需要对不满足flake8规范的代码进行检查/自动格式化代码
- 操作：
- 安装pre-commit插件：pip install pre-commit
- 项目最外层路径编写.pre-commit-config.yaml文件
repos:
- repo: https://gitee.com/irving512/flake8
rev: 3.8.3
hooks:
- id: flake8
- repo: https://gitee.com/irving512/mirrors-yapf
rev: v0.30.0
hooks:
- id: yapf
- 在当前分支执行: pre-commit install
- 重启pycharm
- 提交代码之前， 选中钩子。
- 点击提交， 会自动格式化， 完成后， 再点击提交， 就能提交代码。如果有检查不通过的， 则需要修改代码。
三 ：CommitAngular规范
- CommitAngular规范: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.greljkmo14y0