新手如何写一个好的项目描述文件
新手如何写一个项目的README.md
想写好一个README文件首先需要熟悉MarkDown语法，再次就不过多讲解了。
主要分为几个大的结构就像写简历一样123罗列出来即可;
1.项目概况
2.技术栈
3.项目结构
4.开发环境及依赖
5.友情提示
6.代码规范
7.项目规范
贝程教育-学员笔记助手
学员笔记助手前端项目说明文档，本文档旨在让参与项目人员了解项目结构, 项目依赖, 业务模块, 组件说明, git flow …
技术栈
vue2 vuex vue-router vue-form node koa koa-router webpack scss
项目结构
.
├── build // 构建脚本 webpack, devServer...
├── config // 配置 env, port, host, assetsPath...
├── node_modules // 依赖的第三方包
├── src // 源代码
│ └── client
│ ├── components // 前端通用组件
│ ├── containers // 路由匹配的各页面组件
│ ├── helpers // 功能函数
│ ├── images // 图片资源、
│ ├── routes // 路由配置
│ ├── service // 接口请求函数
│ ├── styles // 样式
│ ├── vuex // 全局 stote. 含有各模块的 action, mutation, getter, state...
│ └── main.js 项目入口文件
├── dist // 源代码编译后的生成线上环境代码
├── .babelrc // babel 配置
├── .editorconfig // 编辑器 code format 配置
├── .eslintrc.js // eslint 配置
├── .gitignore // 不纳入 git 版本控制的 /文件夹?/ 列表
├── package.json // 项目信息文件
└── README.md // 说明
.
开发环境依赖
- node
- yarn
- eslint
推荐工具
- VS Code 写代码利器
- SourceTree 图形化 git
编辑器插件 (无论使用什么IDE，下面列表中 * 开头的插件必装, 以下插件皆为 VS Code 中插件)
- *ESLint
- *EditorConfig
- Vetur
- vue
- Babel
- Path Intellisense
让 VS Code 的 ESLint 插件支持 .vue 文件
打开 VS Code
打开用户设置 windows: 文件 > 首选项 > 设置
打开用户设置 mac: Code > 首选项 > 设置
在 user setting.json 添加下面的代码
"eslint.validate": ["javascript","javascriptreact","html","vue"
]
代码规范 (重要)
!!!本项目遵从airbnbjs 规范， 并将检测集成进 webpack , 所以不符合规范代码无法编译成功。
可以使用编辑器插件自动检测代码规范, 如上方 VS Code 的 ESLint 插件, 其他编辑器自行 google
通用组件
- BackBg
- Header
- SvgIcon
- Loading
SVG 图标 页面
执行以下命令会使用默认浏览器打开 svg 图标页面， 项目中使用的图标尽收于此，单击图标复制代码，组件中引入 SvgIcon 直接粘贴复制的图标代码便可使用
$ npm run openSvg
run & build
# cd 到项目目录
$ cd workspace/wechat-restaurant
# 安装依赖
$ npm install
# 启动开发环境
$ npm run start
git flow
分支
- master // 主干
- dev // 开发主干
- release // 测试分支
- feature // 功能分支
- fixbug // bug 修复分支
工作流
项目人员开发时由 dev 分支创建新的 feature 分支，分支命名规则为对应的任务名字
开发完成后， 向 leader 发起 pull request, code review 完毕合并入 dev 分支
提测时从 dev 分支拉出 release, bug 由 release 分支拉出 fixbug 修复, 修复后发起 pull request, code review 后合并入 release 与 dev
以上请复制到README.md中预览效果，不喜勿喷！
作者：贝程教育
链接：https://www.jianshu.com/p/11fca4b2b27f
来源：简书
简书著作权归作者所有，任何形式的转载都请联系作者获得授权并注明出处。
新手如何写一个好的项目描述文件相关推荐
- 修改程序配置文件 以及写一个结构体数组到文件（以及整数和结构体）
1.修改配置文件 这个mycp 是上一节的 这是TEST.config 代码需用到strstr 这个就是代码 结果这么写不对,缺点东西 改正完的结果是什么呢 ? 这个必须得打开文件 可不可以在外 ...
- vue3使用vite+setup+ts写一个初级前端项目
Vue3vite+setup+ts项目总结 项目说明 项目概述 本项目纯粹是为了学习和巩固刚学的vue3组合式api和语法糖,再加上网上流行vite+ts+vue,所以便有了这个历时四天的vue3前端 ...
- 写一个工具来了解ELF文件（一）
转载请注明出处.https://rhirufxmbcyj.gitlab.io 以前工作需要,研究了一段时间的ELF文件,后来用完了就放置了 最近突然想到当时分析ELF文件格式的时候没有类似专门的工具, ...
- 利用Cocos2d-x写一个程序读取传奇wzl文件
Cocos2d-x是一个用于游戏开发的开源框架,它提供了用于制作2D游戏的工具和功能.若要利用Cocos2d-x读取传奇wzl文件,需要对wzl文件的格式进行分析,并使用Cocos2d-x提供的读取文 ...
- 使用Xcode创建第一个c语言项目和源文件进行编程（xcodes使用教程）
一.Xcode简介 Xcode 是运行在操作系统Mac OS X上的集成开发工具(IDE),由Apple Inc开发.Xcode是开发 macOS 和 iOS 应用程序的最快捷的方式.Xcode 具有 ...
- 如何写一个好的项目策划
项目的特征 项目有一个独特的.可定义的目标或最终的产品 项目是独一无二的 项目是一次性活动 项目含有不确定性 项目需要项目成员复杂而努力的工作产出的变革(创新) 项目管理的五个要素 范围管理 时间管理 ...
- python编写的软件界面-用Python写一个带图形界面的文件压缩软件
这又是一篇用Python写小软件系列,最近有点写上瘾了,文件压缩和解压我们在日常工作学习中会经常用到,比如winrar.快压.好压等压缩软件,猿人学用Python做个简易图形界面的压缩软件. 打开之后 ...
- wps js宏写一个可以批量合并Excel文件表格数据的工具
wps发布JS宏编辑器的功能已经很久了,今天尝试写了个非常简单的Excel表格合并的工具,发现真的是吊打VBA语言!就是有个小小的缺点:不支持外接程序和ActiveX控件,有点可惜,不过终于可以摆脱V ...
- 我写了一个Python小项目
最近我写了一个 Python 练手小项目,它是一个 PC 桌面版的便签程序,很简陋.写这个小项目是为了熟悉一下用 Python 进行一个完整的项目开发,进一步熟练 Python 的使用. 界面是这样的 ...
最新文章
- virtual hust 2013.6.20 数论基础题目 D - Just the Facts
- list对象_list对象，容量自适应的数组式容器
- 图解用Wireshark进行Http协议分析
- jsp中session 和 cookies区别
- vue mui html不解析,记下Vue中使用Mui.js踩到的坑
- JavaScript学习总结(六)——JavaScript判断数据类型总结
- oracle 性能优化 07_诊断事件
- php对象转换为字符串,php – 类的对象..无法转换为字符串
- 带哨兵节点的链_BNC公链 | IPFS：区块链“不可能三角”的可能解
- 硬盘读写测试工具_硬盘测速工具：Blackmagic Disk Speed Test Mac
- Java RMI 服务易受 SSRF 攻击
- Python爬虫-《神雕侠侣》
- 解决ssh登录慢的问题
- SVN客户端日志无法显示的解决
- 板邓：wordpress编辑器发布文章自动首行缩进
- 新版标准日本语初级_第四十五课
- MongoDB～从入门到入坑。
- Maven原始setting.xml文件备份
- unity 环境光、模型、材质发绿，绿的发光
- 【Java】我的世界Java版外挂制作 [4] - 移动类模块合集