如何寫乙個通用的README規範

2021-09-13 23:27:19 字數 777 閱讀 6426

我們平常在進行專案開發時,一般都會把**上傳至**託管平台上方便管理和維護。目前大家使用的託管平台最多的還是github,國內外還有一些比較知名的**託管平台,比如gitlab、bitbucket,碼雲和碼市等。

但我們在多人合作開發下,經常碰到的最頭疼的問題是,其他開發者在交接給我們乙個專案時只是對專案目前現有的功能簡單的描述了下,我們在後續迭代功能時突然發現連最基本的專案如何執行都沒有給我們交代,當時心中一萬隻那個什麼馬奔騰而過,只能去檢視package.json的scripts,自己意會了。

那麼問題來了,我們在交接乙個專案時,如何保證專案能快速完整地交付給**,從此過上無憂無慮的生活呢?答案是我們只需要甩給他乙份標準規範的readme。

上面的readme規範模板在我們

feflow的

readme規範裡可以看到

那麼我們一起來**下,乙份規範完整的readme規範都應該有哪些內容呢?

1. 專案描述

2. 如何執行

3. 業務介紹

4. 專案備註

每一項都有哪些作用?

上面是我們乙個規範的readme所需的一些資訊和內容,加粗內容是我認為readme裡的一些必需資訊,大家也可以在此基礎上針對自己專案實際的開發場景來擴充套件一些規範資訊。

如果對您的團隊或者專案有幫助,請給個star支援一下哈~

如何寫乙個Stack?

1.棧是陣列 2.先進後出 3.出棧 4.入棧 手寫乙個雙向鍊錶 棧 public class stackpopandpush public stackpopandpush int lens 返回元素個數 public intsize 返回陣列長度,容量,棧資料長 private intcapaci...

如何寫乙個鍊錶

有的時候,處於記憶體中的資料並不是連續的。那麼這時候,我們就需要在 資料結構中新增乙個屬性,這個屬性會記錄下面乙個資料的位址。有了這個位址之後,所有的資料就像一條鍊子一樣串起來了,那麼這個位址屬性就起到了穿線鏈結的作用。相比較普通的線性結構,鍊錶結構的優勢是什麼呢?我們可以總結一下 1 單個節點建立...

如何寫乙個Vue元件

寫的是以.vue結尾的單檔案元件的寫法,是基於webpack構建的專案。template 模板 js 邏輯 css 樣式 每個元件都有屬於自己的模板,js和樣式。如果將乙個頁面比喻成一間房子的話,元件就是房子裡的客廳 臥室 廚房 廁所。如果把廚房單獨拿出來的話,元件又可以是刀 油煙機.等等。就是說頁...