# 如何做开源项目

这是我在学习视频课程过程中,记录的课堂笔记。

# 1. 概述

做开源项目,看起来很难的事,我们可能写不出 vue 这种优秀的开源项目,但是我们可以选择一个小的项目进行做,会有很多收获。开源项目会有以下收获:

  • 从全局考虑项目
  • 提升自己的编程能力
  • 提高个人知名度

# 2. 规范

(1)项目的目录规范

  • src,源代码
  • doc,文档
  • relece,发布结果
  • test,测试用例
  • exemple,测试用例

(2)git 分支

项目至少需要两个分支,master 和 dev。

添加版本项目的版本,每个大更新迭代一个大版本。

git tag -a 'v0.0.1' -m "提交代码"

(2)READEME

  • 产品简介
  • 安装和下载
  • 快速开始
  • 交流提问
  • 作者

(3)推广

  • 写博客推广,知乎,掘金
  • 知乎回答问题
更新时间: 2/24/2022, 11:09:51 PM