iT邦幫忙

2024 iThome 鐵人賽

DAY 6
0
Python

利用Python完成自動化測試專案系列 第 14

D14 Github 介紹

  • 分享至 

  • xImage
  •  

今天我們會實際使用 VScode 把我們的專案上傳到 Github。

Github

Github 是上次提到的倉儲的線上版本,除了放 code 以外,也可以查看其他開發者的專案並交流,也有人說 Github 是工程師的 Facebook。

使用方法也很簡單,前往 Github 網頁註冊,註冊好後我們可以選擇手動建立 repo(repository, 儲存庫)或是從 VScode 連到 Github 自動建立,這裡我們選擇後者的作法。

VScode

點擊介面的左上角看起來像樹枝的 icon,進到原始檔控制。
https://ithelp.ithome.com.tw/upload/images/20240926/20169358eJhj6OXaIO.png

點擊發布至 Github,並登入剛剛創立好的 Github帳號。

https://ithelp.ithome.com.tw/upload/images/20240926/20169358NicZbAT3uT.jpg

再來選擇自己的 repo 要不要公開,選擇完後就把 Github 上的 repo 建立好了。
https://ithelp.ithome.com.tw/upload/images/20240926/20169358RzRTijI5SE.jpg
https://ithelp.ithome.com.tw/upload/images/20240926/20169358TD27BGvHVc.jpg

之後有檔案變動都會在原始檔控制顯示,選擇"暫存變更"(等於 Git 的 add)後點擊提交(等於 Git 的 commit)
https://ithelp.ithome.com.tw/upload/images/20240926/20169358xybis4RNX6.jpg

之後點擊同步變更(等於 Git 的 push)就走完版控一次流程了。
https://ithelp.ithome.com.tw/upload/images/20240926/20169358dgj9Daazeo.jpg

https://ithelp.ithome.com.tw/upload/images/20240926/20169358VUaNyGqKJg.jpg

README

在專案 repo 下面會看到 README.md 的欄位,這個地方是對使用者簡述你的 code 如何執行,包含事前安裝套件等等,在專案新增 README.md 推上來就可以顯示。

寫 README 也要遵循一定的規範,可以參考 art-of-readme ,這邊附上它提供的檢查表

  • [ ] 用一行解釋模組的用途
  • [ ] 必要的背景資料與連結
  • [ ] 將可能不熟悉的術語連結到資訊來源
  • [ ] 清楚、可運行的使用範例
  • [ ] 安裝說明
  • [ ] 詳細的 API 文件
  • [ ] 執行認知漏斗
  • [ ] 預先提及注意事項和限制
  • [ ] 不依賴圖像傳遞重要訊息
  • [ ] 授權

commit message 規範

通常初次使用 Git 的人看到 commit 訊息都會忽略填寫message直接上傳到 repo,但 commit message 也需要遵循一定的規範,以讓其他協作者、 review code 的人、甚至未來回頭要繼續開發專案的自己能更快了解狀況。

格式

<type>(<scope>): <subject>

<body>

<footer>

type

  • feat (增加新功能)
  • fix (修正 bug)
  • docs (更動文件)
  • style (格式調整,不更動程式邏輯)
  • refactor (重構)
  • test (增加或重構測試)
  • chore (雜項工作,不影響code)

scope

描述這次更動的範圍

body

對本次 commit 的描述,要具體且明確

footer

特殊情況下的註記,例如版本號等。

明天預計會開始講這個系列的重頭戲-pytest


上一篇
D13 版本控制 Git
下一篇
D15 pytest 介紹
系列文
利用Python完成自動化測試專案23
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言