<aside> 🐢 期末發表完面試前的建議—整理Github Reademe

你知道對專案來說，README.md 有多麼重要嗎？ ── 工程師血淚史

checklist

➤ 專案介紹，如有有ppt就放上連結(記得開權限)

➤ 正式環境URL

➤ 網站架構圖，放圖的方法

➤ 提供整個網站較複雜的”一個”UML流程圖，不用太多

➤ Figma連結（UI/UX 設計稿），(記得開權限)

➤ 提供測試帳號密碼，避免讓人玩壞，如果有做權限提供最低權限帳號即可

➤更改github簡介，修改topic至少要有vuejs css3 side-project，其他看想放什麼都可以

Untitled

➤ 提供協作者資料

期末專題結束調整完成，需要把dev branch 合併到主分支(如master或main)才能夠產出資訊，

方法1: 用Sourcetree

方法2: 用github開PR的教學(找不到簡短的中文教學)

成功合併後會有以下資訊

  1. repo首頁右下角會出現

    1709608380490.jpg

  2. 在Insights → Contributors有以下貢獻圖表

    Contributors to SkerLeon/pxzoo

  3. [可有可無]透過網站自動產出，可以放在readme

    產出協作者的教學

可寫可不寫-比較偏向side-project

➤ 開發中碰到的問題解決方式，有時候會增加專題關鍵字曝光率

➤ 環境檔（.env），僅提供key

➤ 在 Local和Server 端的安裝＆運行步驟

</aside>