AcssBackend

智能(A)充电/计费(C)调度(S)系统(S)的后端仓库，基于 Django 框架与 Python3.10 开发。

[toc]

任务进度

目录结构

repo 根目录：AcssBackend

站点模块：acss_site

配置文件、根路由模块

数据模块：data

ORM 模型、控制器、服务

调度模块：schd

控制器、服务

开发环境配置

基本环境配置

下载安装 Visual Studio Code
(可选) Windows系统环境下需要下载安装git bash
下载安装 Python3.10
- Windows 平台可以在官网下载x86_64 安装包
- Linux 平台可以直接使用包管理工具安装
- macOS 平台在安装 Homebrew 后，可以使用brew安装
- 若感兴趣，可以尝试使用pyenv管理不同版本的 Python
使用git clone https://e.coding.net/segb/ACSS/AcssBackend.git克隆仓库到自己喜欢的位置
打开 Visual Studio Code，打开 AcssBackend 文件夹，在拓展页面搜索并安装Python与Django拓展
在项目根目录打开命令行/控制台（通过 Visual Studio Code 的菜单可以直接打开）
运行pip install -r requirements.txt安装项目依赖
运行python manage.py runserver，启动服务器，若没有出现错误信息并显示了服务地址，配置成功

调试方法

在需要调试的地方打断点
进入 Visual Studio Code 的运行与调试页面，点击创建 launch.json，选择Django
创建完成后，直接关闭launch.json，在运行与调试点击调试按钮，或者使用 F5 功能键
服务器启动后，需要触发断点，请使用接口测试工具进行触发，例如 Postman
(可选) Windows 平台下载并安装 Postman

(可选) Linux 平台下载并安装 Postman

(可选) macOS 平台前往下载页选择芯片版本下载并安装 Postman
(可选) 根据 Postman 指导步骤添加接口用例

版本管理策略

主要分支

主要分支为master与dev分支，默认分支为master分支。

master分支描述：产品的发布分支，用于进行稳定版本的迭代是否受保护：是管理员：jinuo
dev分支描述：产品最新的开发版本，用于进行新功能的测试是否受保护：是管理员：jinuo

分支的分类

为了便于分支管理，将不同功能的分支以特定的格式命名，分支分类如下：

feature 分支：用于进行新功能的开发，命名规则为dev-feat-{feat_name}，feat_name应该由数字、字母、以及下划线组成
fix 分支：用于 issue 的修复，命名方式为dev-fix-{fix_name}，fix_name的命名规则同上
refactor 分支：用于代码的重构，大概率不需要使用，命名方式为dev-refactor-{refactor_name}，refactor_name的命名规则同上

注：使用下划线的目的是将分支的名称与前缀区分开，方便阅读

开发流程

确认需要执行的任务类别
基于dev分支或者自己的子分支按照命名规范创建新分支
进行开发
(可选) 使用merge或rebase指令（建议用merge）将dev分支的提交更新到自己的分支上
使用push推送全部提交
在创建合并请求页面发起PR

创建合并请求的方法

在代码仓库菜单中点击合并请求，点击右上角的创建合并请求，在打开的页面中选择源分支为你自己的分支，目标分支选择dev分支。若提示无法合并，则说明dev分支有新的提交，并且这些提交中修改的代码与你的分支修改的代码有冲突，这时需要执行开发流程中的步骤 4。步骤 4 执行完成后，再回到创建合并请求页面，选择分支后，已可以进行合并。
输入合并请求标题，格式为{merge_type}. {title}，例如“feat. 添加登录注册支持”。确保title在 20 字以内
(可选) 输入描述，如果改动较小，则可以不输入描述。若改动较大或认为又需要特别说明的内容，则可以写在描述中
如果分支为fix类型，则需要在下方的关联资源中关联对应的 issue

提交消息的规范

提交(commit)需要按照规范进行。此项目参考谷歌的 AngularJS 提交规范，具体规范内容可以使用搜索引擎查询。这里推荐使用 Visual Studio Code 进行开发，在拓展中搜索并安装git-commit-plugin，在版本管理页面点击“版本管理”标题右侧的 Github 章鱼按钮，按照提示信息填写提交信息。本项目只需要填写前三条信息，前两条（影响范围和提交标题）必须填写，第三条（提交描述）可选，当涉及到复杂变动时可以填写。

附录教程

Git 的基本使用方法

这里提供一些本项目开发的 git 使用 tips。

推荐使用 Visual Studio Code 提供的 GUI 版本管理功能，可以大幅减小 Git 的学习成本。

commit

提交，一次提交会创建一个提交记录，可以在版本管理页的下方查看。

fetch

本地的版本信息不一定是最新的，例如选择分支时不一定会出现他人刚在代码仓库发布的分支，这时需要使用fetch指令更新仓库信息。建议在 Visual Studio Code 中开启自动定期fetch。

push

将本地的修改（本地的所有新提交）同步到远程代码仓库中，如果左下角的版本状态显示你的版本领先于远程版本，则可以直接推送，否则需要先进行pull操作。

pull

将远程代码仓库的修改同步到本地，如果远程与本地提交有冲突，会触发merge流程，这时需要手工将代码中的冲突消除。

如果在pull本地存在未提交的修改并且不想提交，则需要使用stash暂存功能将代码暂时保存，在pull后apply latest stash将暂存内容应用到现在的代码中，如果存在冲突，解决冲突的流程会在这时候进行。

checkout

切换分支，直接点击 Visual Studio Code 左下角的分支名称，即可选择需要切换到的分支。

注意：切换分支前需要将本地未提交的修改提交，或者stash暂存当前分支的修改

merge

在 Visual Studio Code 版本管理页面中选择分支/合并分支，选择合并自的分支，可以将合并自分支的提交合并到本分支，这样就可以在网页上创建合并请求了。

PopChicken/AcssBackend