---
# System prepended metadata

title: Github專案建立規範
tags: [HyUI4.0]

---

---
type: slide
---

# Github專案建立規範

###### tags:`HyUI4.0`


---

## HyUI 下載

---

## **HyUI版本號/release**
  * 在 github `release `進行下載 
  * 修改 readme 的文件 
    確切紀錄 方便日後歸檔查找   
  
note:
這次我們發佈了 v4.0的板本 可以在側邊的功能列上找到 點擊進去並且下載 

---

![](https://i.imgur.com/LYzS24U.png)

note:
releases 會標注最後的版本以及其餘有多少版本


---

![](https://i.imgur.com/nGWPHd4.png)

note:
點擊進去之後 版本文件會根據修改或是更動多少地方
來標注 這個版本與之前版本的差異

我們可以按下方紅匡處 進行下載

載好檔案 我們頁要根據手上的專案
修改readme的內容


---

## **readme**

* 專案名稱 
* HyUI版本號 
* 經手的UI設計師與切版設計師 


note:
readme 預計會希望大家標注的部分有
專案名稱 版本號 還有經手的設計師

---


![](https://i.imgur.com/RyEul1x.png)

note:

切版時 難免會發現框架所不支援之處 
如果發現哪卡卡或有問題
麻煩大家填寫回報單
搜集問題 方便除錯讓ＨＹＵＩ越來越完善

---

## 問題回報填寫

note:
關於回報問題 我們目前統一放置於githug 的issue上
未來將不再使用之前所提供的excel連結
方便將問題統整與規劃


---

## **回報issue填寫**

 * 在 github `issue`上面回傳問題
 
 * 未來修復 `commit`會根據`issue`上
  提出的問題進行修正

---


 點擊 `issue`
 
![](https://i.imgur.com/7R79Uey.png)



---

 點擊  新增`issue`
![](https://i.imgur.com/ulyYqBD.png)



---


  
填寫問題標題及詳細描寫內容
![](https://i.imgur.com/sNnXMnX.png)



---

可以指定對象修改
(也可不指定 讓人認領)
![](https://i.imgur.com/aMrdFVf.png)


---


指定修改的部分
會歸類在哪個專案看板

<small>(專案看板後面會補充)</small>
![](https://i.imgur.com/2laByk4.png)

---

也可以指定修改的部分
會歸類在哪個階段的里程碑

<small>(里程碑功能後面會補充/如果不清楚也可不指定)</small>

![](https://i.imgur.com/32nI0Rc.png)


---

指定問題分類類別標籤

![](https://i.imgur.com/rD7D8V2.png)

---

確定即可送出issues 

![](https://i.imgur.com/256geZk.png)


---


## 問題修改填寫


---

當接收到問題 或是修改檔案時
我們可以這樣寫...

---

## **commit message規範**

  
  commit message 根據規範填寫 
  
  把 `issue` 上的問題 編號標出
  
  並寫出修改何處供日後查找
  


---


## **修改commit填寫**

  
   **type: subject (簡述) ＋（＃issue編號）**
  


---

類型: subject (簡述) ＋（＃issue編號）

![](https://i.imgur.com/tPsXQ1R.png)



---

可以根據標題 
仔細填寫問題及修改何處

![](https://i.imgur.com/WA4eNvo.png)



---


修改完成可以關閉這個issue

![](https://i.imgur.com/P16vNeH.png)



---

如果還是有問題
也可以再次打開issue

![](https://i.imgur.com/aewjRrF.png)




---

## **Type 使用類別：**

  
  ```
    * feat: 新增/修改功能 (feature)。
	* fix: 修補 bug (bug fix)。
	* docs: 文件 (documentation)。
	* style: 格式 (不影響程式碼運行的變動 white-space,
    formatting, missing semi colons, etc)。
 	* refactor: 重構 (既不是新增功能，也不是修補 bug 的程式碼變動)。
	* perf: 改善效能 (A code change that improves performance)。
	* test: 增加測試 (when adding missing tests)。
	* chore: 建構程序或輔助工具的變動 (maintain)。
	* revert: 撤銷回覆先前的 commit 
    例如：revert: type(scope): subject (回覆版本：xxxx)。
```

---

網路參考範例
  
![](https://i.imgur.com/k9kmtq4.png)



---

## [補充]
## Milestones(里程碑) 和 Projects

---

### **Milestones(里程碑)**

---

在`issue`的頁籤中 可以找到里程碑按鈕

![](https://i.imgur.com/11foolg.png)


---

可以看到各個版本 
根據`issue`所完成的進度

![](https://i.imgur.com/UrsxnRA.png)



---

也可以點擊完成的里程碑 
觀看每個版本修改些部分

![](https://i.imgur.com/7ktJpfH.png)


---

## 關於Projects

---

在部門github 的 Projects 裡 新增一專案看板

![](https://i.imgur.com/WkmBF00.png)


---

![](https://i.imgur.com/zaeZBoJ.png)


---

整合trello功能
點進看板後 可以看到之前填寫的`issue`

![](https://i.imgur.com/ZKcWOiW.png)



---

 也可以在看板上更改`issue`的狀態
 
![](https://i.imgur.com/7hkb7Kl.png)


 

---

## **總結**

*  從 release 上下載版本
*  更新 readme 檔案上面的資料 填寫設計師及切版設計負責人
*  如果有發現問題 可以根據問題填寫 issue
*  根據 issue 填寫 commit message
*  commit message 解決問題後可以關掉 issue
*  若相同處有問題 則可再次打開 issue
*  所有 issue 設定完成後 可以在 Projects 看到每個問題更新狀態 
*  可以在每個里程碑的標籤下 看到更改過哪些 issue 

---

## **練習一下**


* 用以下個連結 提出一個 issue 指定 Projects 為 git_test_project
* 並試試看 在 Projects 看看 issue 的狀態
[專案連結在這邊](https://github.com/HywebU00/git_test)


---

## **參考文件**

 [commit message](https://ithelp.ithome.com.tw/articles/10228738) 
 
  


---




<style>
    .reveal h1{
        font-size:2em;
    }
    .reveal h1,.reveal h2 {
         color:#c9f2ff;
    }
    .reveal{
        font-size:26px;
    }
</style>
