如何为项目贡献代码

一、准备工作

安装 Git；
安装 Sourcetree，这个工具是 git 的一种图形化界面；
注意安装 git 的时候记得勾选将 git 所在目录添加到系统环境变量；

1.DotNet项目

安装 Visual Studio 2022；
安装 Visual Studio 2022 的 CodeMaid 扩展插件，这个插件可以自动格式化代码；
若有新功能开发，请添加文件头，这在后续修改代码文件或多人合作项目时有莫大的好处。如下为我的示例：

#region <<版权版本注释>>

// ----------------------------------------------------------------
// Copyright ©2023 ZhaiFanhua All Rights Reserved.
// Licensed under the MulanPSL2 License. See LICENSE in the project root for license information.
// FileName:ChatHub
// Guid:ee669dee-30c7-4d21-8eb4-f24d8dc0f44c
// Author:zhaifanhua
// Email:me@zhaifanhua.com
// CreatedTime:2023-04-16 上午 03:59:25
// ----------------------------------------------------------------

#endregion <<版权版本注释>>

下面就来说说怎么创建并修改默认模板。

1.新建模板文件

注意：我所用环境为 Visual Studio 2022，以下模板适合 C#10 新语法，旧语法及旧版本以类似方法修改。

在空白目录创建以下三个文件：

Class.cs

#region <<版权版本注释>>

// ----------------------------------------------------------------
// Copyright ©$year$ ZhaiFanhua All Rights Reserved.
// Licensed under the MulanPSL2 License. See LICENSE in the project root for license information.
// FileName:$safeitemname$
// Guid:$guid1$
// Author:$username$
// Email:me@zhaifanhua.com
// CreateTime:$time$
// ----------------------------------------------------------------

#endregion <<版权版本注释>>

namespace $rootnamespace$;

/// <summary>
/// $safeitemrootname$
/// </summary>
public class $safeitemrootname$
{
}

Controller.cs 这里仅为ApiController

#region <<版权版本注释>>

// ----------------------------------------------------------------
// Copyright ©$year$ ZhaiFanhua All Rights Reserved.
// Licensed under the MulanPSL2 License. See LICENSE in the project root for license information.
// FileName:$safeitemname$
// Guid:$guid1$
// Author:$username$
// Email:me@zhaifanhua.com
// CreateTime:$time$
// ----------------------------------------------------------------

#endregion <<版权版本注释>>

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace $rootnamespace$;

/// <summary>
/// $safeitemrootname$
/// </summary>
[Route("api/[controller]")]
[ApiController]
public class $safeitemname$ : ControllerBase
{
}

Interface.cs

#region <<版权版本注释>>

// ----------------------------------------------------------------
// Copyright ©$year$ ZhaiFanhua All Rights Reserved.
// Licensed under the MulanPSL2 License. See LICENSE in the project root for license information.
// FileName:$safeitemname$
// Guid:$guid1$
// Author:$username$
// Email:me@zhaifanhua.com
// CreateTime:$time$
// ----------------------------------------------------------------

#endregion <<版权版本注释>>

namespace $rootnamespace$;

/// <summary>
/// $safeitemrootname$
/// </summary>
public interface $safeitemrootname$
{
}

2.找到模板目录并复制

例如安装的 Visual Studio 2022 在 C 盘，则对应的模板目录在：

Class

C:\Program Files\Microsoft Visual Studio\2022\Community\Common7\IDE\ItemTemplates\CSharp\Code\2052\Class C:\Program Files\Microsoft Visual Studio\2022\Community\Common7\IDE\ItemTemplates\AspNetCore\Code\1033\Class

Interface

C:\Program Files\Microsoft Visual Studio\2022\Community\Common7\IDE\ItemTemplates\CSharp\Code\2052\Interface C:\Program Files\Microsoft Visual Studio\2022\Community\Common7\IDE\ItemTemplates\AspNetCore\Code\1033\Interface

Controller

C:\Program Files\Microsoft Visual Studio\2022\Community\Common7\IDE\ItemTemplates\AspNetCore\Web\ASP.NET\1033\WebApiEmptyController

2.Vue项目

安装 Visual Studio Code；
安装 Visual Studio Code 的 Prettier - Code formatter 扩展插件，这个插件可以自动格式化代码；

二、贡献代码

1. 新建自己的分支（Fork）

将本项目仓库 fork 到自己的 git 仓库中。

2. 克隆（Clone）

将已经 fork 的仓库 clone 到自己的本地 PC。

3. 创建本地分支

如果想要在本项目上做自己的开发，最好创建属于自己的项目分支，如果是直接贡献代码，那么可以直接在 dev 分支上进行操作。

4. 开发

发现了一个小 Bug 并进行修改。
在打开的 Issues 中选择功能并进行开发。

5. 提交（Commit）

向本地仓库提交 Bug。

规范：

emoji	emoji 代码	commit 说明
(调色板)	`:art:`	改进代码结构/代码格式
(闪电) (赛马)	`:zap:` `:racehorse:`	提升性能
(火焰)	`:fire:`	移除代码或文件
(bug)	`:bug:`	修复 bug
(急救车)	`:ambulance:`	重要补丁
(火花)	`:sparkles:`	引入新功能
(备忘录)	`:memo:`	撰写文档
(火箭)	`:rocket:`	部署功能
(口红)	`:lipstick:`	更新 UI 和样式文件
(庆祝)	`:tada:`	初次提交
(白色复选框)	`:white_check_mark:`	更新测试
(锁)	`:lock:`	修复安全问题
(苹果)	`:apple:`	修复 macOS 下的问题
(企鹅)	`:penguin:`	修复 Linux 下的问题
(旗帜)	`:checked_flag:`	修复 Windows 下的问题
:robot:（机器人）	`:robot:`	修复 Android 下的问题
(绿苹果)	`:green_apple:`	修复 iOS 下的问题
(书签)	`:bookmark:`	发行/版本标签
(警车灯)	`:rotating_light:`	移除 linter 警告
(施工)	`:construction:`	工作进行中
(工人)	`:construction_worker:`	添加 CI 构建系统
(绿心)	`:green_heart:`	修复 CI 构建问题
(上升箭头)	`:arrow_up:`	升级依赖
(下降箭头)	`:arrow_down:`	降级依赖
(图钉)	`:pushpin:`	将依赖项固定到特定版本
(上升趋势图)	`:chart_with_upwards_trend:`	添加分析或跟踪代码
（回收）	`:recycle:`	重构代码
(鲸鱼)	`:whale:`	Docker 相关工作
(带子午线的地球仪)	`:globe_with_meridians:`	国际化与本地化
(加号)	`:heavy_plus_sign:`	增加一个依赖
(减号)	`:heavy_minus_sign:`	减少一个依赖
(扳手)	`:wrench:`	修改配置文件
(锤子)	`:hammer:`	重大重构
(铅笔)	`:pencil2:`	修复 typo
(粑粑...)	`:hankey:`	写了辣鸡代码需要优化
(倒带)	`:rewind:`	恢复更改
(交叉向右的箭头)	`:twisted_rightwards_arrows:`	合并分支
(包裹)	`:package:`	更新编译的文件或包
(外星人)	`:alien:`	由于外部API更改而更新代码
(货车)	`:truck:`	移动或者重命名文件
(正面朝上的页面)	`:page_facing_up:`	增加或更新许可证书
(爆炸)	`:boom:`	引入突破性的变化
(铅笔)	`:bento:`	增加或更新资源
(OK手势)	`:ok_hand:`	由于代码审查更改而更新代码
(轮椅)	`:wheelchair:`	改善无障碍交互
(灯泡)	`:bulb:`	给代码添加注释
(啤酒)	`:beers:`	醉醺醺地写代码...
(消息气泡)	`:speech_balloon:`	更新文本文档
:card_file_box: (卡片文件盒)	`:card_file_box:`	执行与数据库相关的更改
(音量大)	`:loud_sound:`	增加日志
(静音)	`:mute:`	移除日志
(轮廓中的半身像)	`:busts_in_silhouette:`	增加贡献者
(孩童通行)	`:children_crossing:`	优化用户体验、可用性
:building_construction: (建筑建造)	`:building_construction:`	结构变动
(iPhone)	`:iphone:`	做响应式设计
:clown_face: (小丑脸)	`:clown_face:`	嘲弄事物（直译，这个没明白）
(鸡蛋)	`:egg:`	增加彩蛋
(看不见邪恶)	`:see_no_evil:`	增加或更改gitignore
:camera_flash: (照相机闪光灯)	`:camera_flash:`	增加或更新截图
:alembic: (蒸馏器)	`:alembic:`	尝试新东西
(放大镜)	`:mag:`	SEO优化
:wheel_of_dharma: (船的方向盘)	`:wheel_of_dharma:`	关于Kubernetes的工作
:label: (标签)	`:label:`	增加类型（FLow、Typescript）