docs(introduction): fix title syntax typo

This commit is contained in:
YuLe 2021-10-28 13:40:18 +08:00 committed by GitHub
parent 152c11f193
commit e9c0ef9952
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,6 +1,6 @@
#介绍
# 介绍
##Github
## Github
Wiki百科上是这么说的
@ -25,7 +25,7 @@ Wiki百科上是这么说的
等等。看上去像是大餐,但是你还需要了解点什么?
###版本管理与软件部署
### 版本管理与软件部署
jQuery[^jQuery]在发布版本``2.1.3``一共有152个commit。我们可以看到如下的提交信息:
@ -36,7 +36,7 @@ jQuery[^jQuery]在发布版本``2.1.3``一共有152个commit。我们可以
- Build: Update commitplease dev dependency
- ...
###Github与Git
### Github与Git
> Git是一个分布式的版本控制系统最初由Linus Torvalds编写用作Linux内核代码的管理。在推出后Git在其它项目中也取得了很大成功尤其是在Ruby社区中。目前包括Rubinius、Merb和Bitcoin在内的很多知名项目都使用了Git。Git同样可以被诸如Capistrano和Vlad the Deployer这样的部署工具所使用。
@ -44,11 +44,11 @@ jQuery[^jQuery]在发布版本``2.1.3``一共有152个commit。我们可以
[^jQuery]: jQuery是一套跨浏览器的JavaScript库简化HTML与JavaScript之间的操作。
##用好Github
## 用好Github
如何用好Github,并实践一些敏捷软件开发是一个很有意思的事情.我们可以在上面做很多事情,从测试到CI,再到自动部署.
###敏捷软件开发
### 敏捷软件开发
显然我是在扯淡,这和敏捷软件开发没有什么关系。不过我也不知道瀑布流是怎样的。说说我所知道的一个项目的组成吧:
@ -63,7 +63,7 @@ jQuery[^jQuery]在发布版本``2.1.3``一共有152个commit。我们可以
当只有一个人的时候你只需要明确知道自己想要什么就够了。我们还需要的是CI、测试以来提升代码的质量。
###测试
### 测试
通常我们都会找Document如果没有的话你会找什么?看源代码,还是看测试?
@ -125,7 +125,7 @@ lettuce.js | 98.58% (209 / 212)| 82.98%(78 / 94) | 100.00% (54 / 54) | 98.58% (2
本地测试都通过了,于是我们添加了``Travis-CI``来跑我们的测试
###CI
### CI
虽然node.js不算是一门语言但是因为我们用的node下面的是一个简单的``.travis.yml``示例:
@ -148,7 +148,7 @@ after_success: CODECLIMATE_REPO_TOKEN=321480822fc37deb0de70a11931b4cb6a2a3cc4116
CI对于一个开发者在不同城市开发同一项目上来说是很重要的这意味着当你添加的部分功能有测试覆盖的时候项目代码会更加强壮。
###代码质量
### 代码质量
像``jslint``这类的工具只能保证代码在语法上是正确的但是不能保证你没有写一堆bad smell的代码。
@ -199,7 +199,7 @@ Lettuce.send = function (url, method, callback, data) {
这就意味着我们可以对上面的代码进行重构,他们是重复的代码。
###重构
### 重构
不想在这里说太多关于``重构``的东西可以参考Martin Flower的《重构》一书去多了解一些重构的细节。