Jelajahi Sumber

doc: 完善分支命名规范文档;修正项目规范两处格式问题;

Walker 3 tahun lalu
induk
melakukan
3aa1019c70
2 mengubah file dengan 45 tambahan dan 41 penghapusan
  1. 7 3
      分支命名规范.md
  2. 38 38
      项目规范.md

+ 7 - 3
分支命名规范.md

@@ -40,15 +40,19 @@
 
 - publish: 线上发布分支,是生产环境的构建分支;
 
-- master: 主分支,一般不允许直接在该分支上进行开发(除非是单人负责的项目)
+- master: 主分支,一般不允许直接在该分支上进行开发;
 
 - hotfix: 修复分支,主要是针对已上线的功能出现严重缺陷需要紧急修复,或者修复的缺陷跟历史版本没有强关联性的情况下使用;如果能追溯缺陷的关联版本,还是需要按照上面的[根据原型版本号命名规范](#name-by-version),用版本号 + `_hotfix` 后缀去命名分支;
 
 - feat_[功能英文描述]: 进行特定功能需求开发的分支,对于无需求版本的开发功能,统一使用这种格式的命名规范;
 
-对于前后端项目,同一个需求版本,命名必须保持一致;对于特殊的分支命名,也要统一。
 
-## 备注
+
+## 注意事项
+
+- 对于前后端项目,同一个需求版本,命名必须保持一致;对于特殊的分支命名,也要求统一。
+
+- master 分支原则上禁止直接在其上开发和提交,但也有例外:如单人专门负责的模块,不涉及协作(但多版本迭代仍然需要开启多分支);还有一些特殊项目,如 [grpc-services-def](https://gogs.ywtinfo.com/ywt/grpc_services_def),这个项目是多个项目公用的 grpc 定义文件,统一在 master 分支开发,遇到冲突必须协作解决。
 
 - 由于历史原因,前端有部分项目的分支命名存在混乱,需要进一步规范化。
 

+ 38 - 38
项目规范.md

@@ -230,36 +230,36 @@ package.json
 
     示例:
 
-```js
-// 对象
-let isObject = {};
-// 函数
-function isFun(){
- ...
-};
-// 实例
-let myBbj = new Object();
-```
+    ```js
+    // 对象
+    let isObject = {};
+    // 函数
+    function isFun(){
+     ...
+    };
+    // 实例
+    let myBbj = new Object();
+    ```
 
 8. 类命名或者构造函数,采用大驼峰命名
 
     示例
 
-```js
-// 类
-class Point {
-  ...
-};
+    ```js
+    // 类
+    class Point {
+      ...
+    };
 
-// 构造函数
-function User(options) {
-  this.name = options.name;
-}
+    // 构造函数
+    function User(options) {
+      this.name = options.name;
+    }
 
-let myBbj = new User({
-  name: 'yup'
-});
-```
+    let myBbj = new User({
+      name: 'yup'
+    });
+    ```
 
 
 9. 避免 magic number
@@ -268,21 +268,21 @@ let myBbj = new User({
 
     要将 magic number 定义为常量,并增加注释。示例:
 
-```js
-// 接口成功返回的标识
-const SUCCESS_CODE = 1;
-// 接口失败返回的标识
-const FAIL_CODE = 0;
-
-$.ajax({
-  url: baseUrl + 'v1/activity/getAct',
-  type: 'GET',
-  dataType: 'json',
-  success: function(result) {
-    // do something
-  }
-});
-```
+    ```js
+    // 接口成功返回的标识
+    const SUCCESS_CODE = 1;
+    // 接口失败返回的标识
+    const FAIL_CODE = 0;
+    
+    $.ajax({
+      url: baseUrl + 'v1/activity/getAct',
+      type: 'GET',
+      dataType: 'json',
+      success: function(result) {
+        // do something
+      }
+    });
+    ```
 
 
 #### CSS 命名规范