為你的開源專案加些文件 讓它看起來很專業吧

在 Github 上逛知名專案時，有沒有發現他們都有一個共同點: 文件豐富，有許多專案甚至會專門建立一個網站做

• 簡介
• Demo
• API Documentation
• Wiki
• 論壇

看到這裡，你可能會說在小專案要求這些實在是太強人所難了吧。

其實啊，專案剛起步時，我們可以先從基礎的做起，例如這些被 check in 在各個知名 Git Repositories 中的文件

• README.md
• CHANGELOG.md
• CODE_OF_CONDUCT.md
• CONTRIBUTING.md
• LICENSE.md

這些隨著程式碼擺放在 Repository 中的文件可以說是最基礎但又是最重要的文件，如果你的專案還沒有這些東西的話趕快來把它們加上去，可以讓你的專案瞬間變得很專業喔 XD

那我們要怎麼寫出好的文件呢? 從模仿開始吧

• 好的 README.md 可以看 https://www.makeareadme.com/
• 好的 CHANGELOG.md 可以看 https://keepachangelog.com/en/1.0.0/
• 好的 CODE_OF_CONDUCT.md 可以看 https://www.contributor-covenant.org/
• 好的 CONTRIBUTING.md 可以看 https://github.com/github/docs/blob/main/CONTRIBUTING.md 或 https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors
• 好的 LICENSE.md 可以看 https://choosealicense.com/ 或 https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/licensing-a-repository

就醬，簡單吧😁

補充一個，Git Repository 的 commits 其實也是一種另類的文，所以，好的 Git Commits 可以看 https://www.conventionalcommits.org/en/v1.0.0/