diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..a84d20d --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,12 @@ +# These are supported funding model platforms + +github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] +patreon: # Replace with a single Patreon username +open_collective: # Replace with a single Open Collective username +ko_fi: # Replace with a single Ko-fi username +tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel +community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry +liberapay: # Replace with a single Liberapay username +issuehunt: # Replace with a single IssueHunt username +otechie: # Replace with a single Otechie username +custom: https://book.douban.com/subject/33477112/ diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml new file mode 100644 index 0000000..b9c9160 --- /dev/null +++ b/.github/workflows/static.yml @@ -0,0 +1,43 @@ +# Simple workflow for deploying static content to GitHub Pages +name: Deploy static content to Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: ["gh-pages"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Single deploy job since we're just deploying + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Pages + uses: actions/configure-pages@v5 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Upload entire repository + path: '.' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/Makefile b/Makefile index 1a5e3b7..a8f2423 100644 --- a/Makefile +++ b/Makefile @@ -11,30 +11,25 @@ markdown: html: markdown pandoc -s $(filename).md -t html5 -o index.html -c style.css \ + --metadata pagetitle=$(title) \ --include-in-header $(include_dir)/head.html \ --include-before-body $(include_dir)/author.html \ --include-before-body $(include_dir)/share.html \ --include-after-body $(include_dir)/stats.html \ --title-prefix $(title) \ - --normalize \ - --smart \ + --toc-depth=3 \ --toc epub: markdown - pandoc -s $(filename).md --normalize --smart -t epub -o $(filename).epub \ + pandoc -s $(filename).md -t epub -o $(filename).epub \ --epub-metadata $(include_dir)/metadata.xml \ - --epub-stylesheet epub.css \ --epub-cover-image img/cover.jpg \ --title-prefix $(title) \ - --normalize \ - --smart \ --toc rtf: markdown pandoc -s $(filename).md -o $(filename).rtf \ - --title-prefix $(title) \ - --normalize \ - --smart + --title-prefix $(title) pdf: markdown # OS X: http://www.tug.org/mactex/ @@ -42,12 +37,10 @@ pdf: markdown # Then symlink it: ln -s /path/to/pdflatex /usr/local/bin pandoc -s $(filename).md -o $(filename).pdf \ --title-prefix $(title) \ + --listings -H listings-setup.tex \ --template=template.tex \ - --normalize \ - --smart \ - --toc \ - --latex-engine=`which xelatex` + --toc mobi: epub # Symlink bin: ln -s /path/to/kindlegen /usr/local/bin - kindlegen $(filename).epub \ No newline at end of file + kindlegen $(filename).epub diff --git a/README.md b/README.md index c38c26e..9c72cfb 100644 --- a/README.md +++ b/README.md @@ -1,120 +1,21 @@ -#GitHub 漫游指南 +# GitHub 漫游指南 -在线阅读: [GitHub 漫游指南](http://github.phodal.com/), 下载: [pdf](https://github.com/phodal/github-roam/raw/gh-pages/github-roam.pdf)、[mobi](https://github.com/phodal/github-roam/raw/gh-pages/github-roam.mobi)、[epub](https://github.com/phodal/github-roam/raw/gh-pages/github-roam.epub) +> 漫游,即随意游玩~。 -2014年,写了《[一步步搭建物联网系统](https://github.com/phodal/designiot)》(电子书)。 +在线阅读:[GitHub 漫游指南](http://github.phodal.com/),下载:[pdf](https://github.com/phodal/github-roam/raw/gh-pages/github-roam.pdf)、[mobi](https://github.com/phodal/github-roam/raw/gh-pages/github-roam.mobi)、[epub](https://github.com/phodal/github-roam/raw/gh-pages/github-roam.epub) -2015.3.9号,想着写个《[GitHub漫游指南](http://github.phodal.com/)》,于是在最开始的地方写着: +2014 年,写了《[一步步搭建物联网系统](https://github.com/phodal/designiot)》(电子书)。 -> 我的GitHub主页上写着加入的时间——``Joined on Nov 8, 2010``,那时才大一,在那之后的那长日子里我都没有过到。也许是因为我学的不是计算机,到了今天——``2015.3.9``,我也发现这其实是程序员的社交网站。 +2015.3.9 号,想着写个《[GitHub 漫游指南](http://github.phodal.com/)》,于是在最开始的地方写着: -但是过了很久都没有动静,今天是2015.10.24,我想是时候完成这个目标了。 +> 我的 GitHub 主页上写着加入的时间——``Joined on Nov 8, 2010``,那时才大一。在那之后的日子里,也许是因为我学的不是计算机的关系,并没有熟练使用它。到了今天——``2015.3.9``,我发现 GitHub 是程序员的社交网站。 -##目录 - -- [前言](http://github.phodal.com/#前言) - - [我与GitHub的故事](http://github.phodal.com/#我与github的故事) - - [GitHub与收获](http://github.phodal.com/#github与收获) - - [GitHub与成长](http://github.phodal.com/#github与成长) - - [为什么你应该深入GitHub](http://github.phodal.com/#为什么你应该深入github) - - [方便工作](http://github.phodal.com/#方便工作) - - [获得一份工作](http://github.phodal.com/#获得一份工作) - - [扩大交际](http://github.phodal.com/#扩大交际) -- [Git基本知识与GitHub使用](http://github.phodal.com/#git基本知识与github使用) - - [Git](http://github.phodal.com/#git) - - [Git初入](http://github.phodal.com/#git初入) - - [GitHub](http://github.phodal.com/#github) - - [版本管理与软件部署](http://github.phodal.com/#版本管理与软件部署) - - [GitHub与Git](http://github.phodal.com/#github与git) - - [在GitHub创建项目](http://github.phodal.com/#在github创建项目) - - [GitHub流行项目分析](http://github.phodal.com/#github流行项目分析) - - [Pull Request](http://github.phodal.com/#pull-request) - - [我的第一个PR](http://github.phodal.com/#我的第一个pr) - - [CLA](http://github.phodal.com/#cla) -- [构建GitHub项目](http://github.phodal.com/#构建github项目) - - [如何用好GitHub](http://github.phodal.com/#如何用好github) - - [敏捷软件开发](http://github.phodal.com/#敏捷软件开发) - - [测试](http://github.phodal.com/#测试) - - [CI](http://github.phodal.com/#ci) - - [代码质量](http://github.phodal.com/#代码质量) - - [模块分离与测试](http://github.phodal.com/#模块分离与测试) - - [代码模块化](http://github.phodal.com/#代码模块化) - - [自动化测试](http://github.phodal.com/#自动化测试) - - [Jshint](http://github.phodal.com/#jshint) - - [Mocha](http://github.phodal.com/#mocha) - - [测试示例](http://github.phodal.com/#测试示例) - - [代码质量与重构](http://github.phodal.com/#代码质量与重构) - - [Code Climate](http://github.phodal.com/#code-climate) - - [代码的坏味道](http://github.phodal.com/#代码的坏味道) -- [创建项目文档](http://github.phodal.com/#创建项目文档) - - [README](http://github.phodal.com/#readme) - - [在线文档](http://github.phodal.com/#在线文档) - - [可用示例](http://github.phodal.com/#可用示例) -- [测试](http://github.phodal.com/#测试-1) - - [TDD](http://github.phodal.com/#tdd) - - [一次测试驱动开发](http://github.phodal.com/#一次测试驱动开发) - - [说说TDD](http://github.phodal.com/#说说tdd) - - [TDD思考](http://github.phodal.com/#tdd思考) - - [功能测试](http://github.phodal.com/#功能测试) - - [轻量级网站测试TWill](http://github.phodal.com/#轻量级网站测试twill) - - [Twill 登陆测试](http://github.phodal.com/#twill-登陆测试) - - [Twill 测试脚本](http://github.phodal.com/#twill-测试脚本) - - [Fake Server](http://github.phodal.com/#fake-server) -- [重构](http://github.phodal.com/#重构) - - [为什么重构?](http://github.phodal.com/#为什么重构) - - [重构uMarkdown](http://github.phodal.com/#重构umarkdown) - - [代码说明](http://github.phodal.com/#代码说明) - - [Interllij - Idea重构](http://github.phodal.com/#interllij-idea重构) - - [Rename](http://github.phodal.com/#rename) - - [Extract Method](http://github.phodal.com/#extract-method) - - [Inline Method](http://github.phodal.com/#inline-method) - - [Pull Members Up](http://github.phodal.com/#pull-members-up) - - [重构之以查询取代临时变量](http://github.phodal.com/#重构之以查询取代临时变量) -- [如何在GitHub“寻找灵感(fork)”](http://github.phodal.com/#如何在github寻找灵感fork) - - [](http://github.phodal.com/#lettuce构建过程)[Lettuce](https://github.com/phodal/lettuce)构建过程 - - [需求](http://github.phodal.com/#需求) - - [计划](http://github.phodal.com/#计划) - - [实现第一个需求](http://github.phodal.com/#实现第一个需求) - - [实现第二个需求](http://github.phodal.com/#实现第二个需求) -- [GitHub用户分析](http://github.phodal.com/#github用户分析) - - [生成图表](http://github.phodal.com/#生成图表) - - [数据解析](http://github.phodal.com/#数据解析) - - [Matplotlib](http://github.phodal.com/#matplotlib) - - [每周分析](http://github.phodal.com/#每周分析) - - [python github - 每周情况分析](http://github.phodal.com/#python-github-每周情况分析) - - [Python 数据分析](http://github.phodal.com/#python-数据分析) - - [Python - Matplotlib图表](http://github.phodal.com/#python-matplotlib图表) - - [存储到数据库中](http://github.phodal.com/#存储到数据库中) - - [SQLite3](http://github.phodal.com/#sqlite3) - - [数据导入](http://github.phodal.com/#数据导入) - - [Redis](http://github.phodal.com/#redis) - - [邻近算法与相似用户](http://github.phodal.com/#邻近算法与相似用户) -- [GitHub连击](http://github.phodal.com/#github连击) - - [100天](http://github.phodal.com/#天) - - [40天的提升](http://github.phodal.com/#天的提升) - - [100天的挑战](http://github.phodal.com/#天的挑战) - - [140天的希冀](http://github.phodal.com/#天的希冀) - - [200天的Showcase](http://github.phodal.com/#天的showcase) - - [一些项目简述](http://github.phodal.com/#一些项目简述) - - [google map solr polygon - 搜索](http://github.phodal.com/#google-map-solr-polygon-搜索) - - [技能树](http://github.phodal.com/#技能树) - - [365天](http://github.phodal.com/#天-1) - - [编程的基础能力](http://github.phodal.com/#编程的基础能力) - - [技术与框架设计](http://github.phodal.com/#技术与框架设计) - - [领域与练习](http://github.phodal.com/#领域与练习) - - [其他](http://github.phodal.com/#其他-1) +但是过了很久都没有动静,今天是 2015.10.24,我想是时候完成这个目标了。 ## License -![cc](https://i.creativecommons.org/l/by-nc/4.0/88x31.png) - -本作品采用[知识共享署名-非商业性使用 4.0 国际许可协议](http://creativecommons.org/licenses/by-nc/4.0/)进行许可。 - -[![Phodal's Articles](http://brand.phodal.com/shields/article-small.svg)](http://articles.phodal.com/) +[![Phodal's Book](http://brand.phodal.com/shields/book-small.svg)](https://www.phodal.com/) -[待我代码编成,娶你为妻可好](http://www.xuntayizhan.com/person/ji-ke-ai-qing-zhi-er-shi-dai-wo-dai-ma-bian-cheng-qu-ni-wei-qi-ke-hao-wan/)。 +© 2015~2019 [Phodal Huang](https://www.phodal.com). This code is distributed under the Creative Commons Attribution-Noncommercial-No Derivative Works 3.0 License. See `LICENSE` in this directory. +[![待我代码编成,娶你为妻可好](http://brand.phodal.com/slogan/slogan.svg)](http://www.xuntayizhan.com/person/ji-ke-ai-qing-zhi-er-shi-dai-wo-dai-ma-bian-cheng-qu-ni-wei-qi-ke-hao-wan/) diff --git a/build/author.html b/build/author.html index 0f6865f..aa51e49 100644 --- a/build/author.html +++ b/build/author.html @@ -3,6 +3,25 @@

GitHub 漫游指南

项目首页: GitHub 漫游指南

By Phodal Huang(微博、知乎、GitHub、SegmentFault: @phodal)

+ +

我的其他电子书:

+ +

微信公众号

- +

+

+当前为预览版,在使用的过程中遇到任何遇到请及时与我联系。阅读过程中问题,不烦在GitHub上提出来: +Issues +

+

+阅读过程中遇到语法错误、拼写错误、技术错误等等,不烦来个Pull Request,这样可以帮助到其他阅读这本电子书的童鞋。

\ No newline at end of file diff --git a/build/share.html b/build/share.html index 4e7cbdf..d5c86d8 100644 --- a/build/share.html +++ b/build/share.html @@ -1,5 +1,5 @@
-
\ No newline at end of file diff --git a/chapters/01-introduction.md b/chapters/01-introduction.md new file mode 100644 index 0000000..cd3fae6 --- /dev/null +++ b/chapters/01-introduction.md @@ -0,0 +1,206 @@ +# 介绍 + +## Github + +Wiki百科上是这么说的 + +> GitHub 是一个共享虚拟主机服务,用于存放使用Git版本控制的软件代码和内容项目。它由GitHub公司(曾称Logical Awesome)的开发者Chris Wanstrath、PJ Hyett和Tom Preston-Werner +使用Ruby on Rails编写而成。 + +当然让我们看看官方的介绍: + +> GitHub is the best place to share code with friends, co-workers, classmates, and complete strangers. Over eight million people use GitHub to build amazing things together. + + +它还是什么? + +- 网站 +- 免费博客 +- 管理配置文件 +- 收集资料 +- 简历 +- 管理代码片段 +- 托管编程环境 +- 写作 + +等等。看上去像是大餐,但是你还需要了解点什么? + +### 版本管理与软件部署 + +jQuery[^jQuery]在发布版本``2.1.3``,一共有152个commit。我们可以看到如下的提交信息: + + - Ajax: Always use script injection in globalEval … bbdfbb4 + - Effects: Reintroduce use of requestAnimationFrame … 72119e0 + - Effects: Improve raf logic … 708764f + - Build: Move test to appropriate module fbdbb6f + - Build: Update commitplease dev dependency + - ... + +### Github与Git + +> Git是一个分布式的版本控制系统,最初由Linus Torvalds编写,用作Linux内核代码的管理。在推出后,Git在其它项目中也取得了很大成功,尤其是在Ruby社区中。目前,包括Rubinius、Merb和Bitcoin在内的很多知名项目都使用了Git。Git同样可以被诸如Capistrano和Vlad the Deployer这样的部署工具所使用。 + +> GitHub可以托管各种git库,并提供一个web界面,但与其它像 SourceForge或Google Code这样的服务不同,GitHub的独特卖点在于从另外一个项目进行分支的简易性。为一个项目贡献代码非常简单:首先点击项目站点的“fork”的按钮,然后将代码检出并将修改加入到刚才分出的代码库中,最后通过内建的“pull request”机制向项目负责人申请代码合并。已经有人将GitHub称为代码玩家的MySpace。 + +[^jQuery]: jQuery是一套跨浏览器的JavaScript库,简化HTML与JavaScript之间的操作。 + +## 用好Github + +如何用好Github,并实践一些敏捷软件开发是一个很有意思的事情.我们可以在上面做很多事情,从测试到CI,再到自动部署. + +### 敏捷软件开发 + +显然我是在扯淡,这和敏捷软件开发没有什么关系。不过我也不知道瀑布流是怎样的。说说我所知道的一个项目的组成吧: + + - 看板式管理应用程序(如trello,简单地说就是管理软件功能) + - CI(持续集成) + - 测试覆盖率 + - 代码质量(code smell) + +对于一个不是远程的团队(如只有一个人的项目) 来说,Trello、Jenkin、Jira不是必需的: + +> 你存在,我深深的脑海里 + +当只有一个人的时候,你只需要明确知道自己想要什么就够了。我们还需要的是CI、测试,以来提升代码的质量。 + +### 测试 + +通常我们都会找Document,如果没有的话,你会找什么?看源代码,还是看测试? + +```javascript +it("specifying response when you need it", function (done) { + var doneFn = jasmine.createSpy("success"); + + lettuce.get('/some/cool/url', function (result) { + expect(result).toEqual("awesome response"); + done(); + }); + + expect(jasmine.Ajax.requests.mostRecent().url).toBe('/some/cool/url'); + expect(doneFn).not.toHaveBeenCalled(); + + jasmine.Ajax.requests.mostRecent().respondWith({ + "status": 200, + "contentType": 'text/plain', + "responseText": 'awesome response' + }); +}); +``` + +代码来源: [https://github.com/phodal/lettuce](https://github.com/phodal/lettuce) + +上面的测试用例,清清楚楚地写明了用法,虽然写得有点扯。 + +等等,测试是用来干什么的。那么,先说说我为什么会想去写测试吧: + + - 我不希望每次做完一个个新功能的时候,再手动地去测试一个个功能。(自动化测试) + - 我不希望在重构的时候发现破坏了原来的功能,而我还一无所知。 + - 我不敢push代码,因为我没有把握。 + +虽然,我不是TDD的死忠,测试的目的是保证功能正常,TDD没法让我们写出质量更高的代码。但是有时TDD是不错的,可以让我们写出逻辑更简单地代码。 + +也许你已经知道了``Selenium``、``Jasmine``、``Cucumber``等等的框架,看到过类似于下面的测试 + +``` + Ajax + ✓ specifying response when you need it + ✓ specifying html when you need it + ✓ should be post to some where + Class + ✓ respects instanceof + ✓ inherits methods (also super) + ✓ extend methods + Effect + ✓ should be able fadein elements + ✓ should be able fadeout elements +``` + +代码来源: [https://github.com/phodal/lettuce](https://github.com/phodal/lettuce) + +看上去似乎每个测试都很小,不过补完每一个测试之后我们就得到了测试覆盖率 + +File | Statements | Branches | Functions | Lines +-----|------------|----------|-----------|------ +lettuce.js | 98.58% (209 / 212)| 82.98%(78 / 94) | 100.00% (54 / 54) | 98.58% (209 / 212) + +本地测试都通过了,于是我们添加了``Travis-CI``来跑我们的测试 + +### CI + +虽然node.js不算是一门语言,但是因为我们用的node,下面的是一个简单的``.travis.yml``示例: + +```yml +language: node_js +node_js: + - "0.10" + +notifications: + email: false + +before_install: npm install -g grunt-cli +install: npm install +after_success: CODECLIMATE_REPO_TOKEN=321480822fc37deb0de70a11931b4cb6a2a3cc411680e8f4569936ac8ffbb0ab codeclimate < coverage/lcov.info +``` + +代码来源: [https://github.com/phodal/lettuce](https://github.com/phodal/lettuce) + +我们把这些集成到``README.md``之后,就有了之前那张图。 + +CI对于一个开发者在不同城市开发同一项目上来说是很重要的,这意味着当你添加的部分功能有测试覆盖的时候,项目代码会更加强壮。 + +### 代码质量 + +像``jslint``这类的工具,只能保证代码在语法上是正确的,但是不能保证你没有写一堆bad smell的代码。 + + - 重复代码 + - 过长的函数 + - 等等 + +``Code Climate``是一个与github集成的工具,我们不仅仅可以看到测试覆盖率,还有代码质量。 + +先看看上面的ajax类: + +```javascript +Lettuce.get = function (url, callback) { + Lettuce.send(url, 'GET', callback); +}; + +Lettuce.send = function (url, method, callback, data) { + data = data || null; + var request = new XMLHttpRequest(); + if (callback instanceof Function) { + request.onreadystatechange = function () { + if (request.readyState === 4 && (request.status === 200 || request.status === 0)) { + callback(request.responseText); + } + }; + } + request.open(method, url, true); + if (data instanceof Object) { + data = JSON.stringify(data); + request.setRequestHeader('Content-Type', 'application/json'); + } + request.setRequestHeader('X-Requested-With', 'XMLHttpRequest'); + request.send(data); +}; +``` + +代码来源: [https://github.com/phodal/lettuce](https://github.com/phodal/lettuce) + +在[Code Climate](https://codeclimate.com/github/phodal/lettuce/src/ajax.js)在出现了一堆问题 + + - Missing "use strict" statement. (Line 2) + - Missing "use strict" statement. (Line 14) + - 'Lettuce' is not defined. (Line 5) + +而这些都是小问题啦,有时可能会有 + + - Similar code found in two :expression_statement nodes (mass = 86) + +这就意味着我们可以对上面的代码进行重构,他们是重复的代码。 + +### 重构 + +不想在这里说太多关于``重构``的东西,可以参考Martin Flower的《重构》一书去多了解一些重构的细节。 + +这时想说的是,只有代码被测试覆盖住了,那么才能保证重构的过程没有出错。 diff --git a/chapters/01-prelude.md b/chapters/01-prelude.md deleted file mode 100644 index 4a27e7e..0000000 --- a/chapters/01-prelude.md +++ /dev/null @@ -1,81 +0,0 @@ -#前言 - -我的GitHub主页上写着加入的时间——``Joined on Nov 8, 2010``,那时才大一,在那之后的那长日子里我都没有过到。也许是因为我学的不是计算机,到了今天——``2015.3.9``,我也发现这其实是程序员的社交网站。 - -过去,曾经有很长的一些时间我试过在GitHub上连击,也试着去了解别人是如何用好这个工具的。当然粉丝在GitHub上也是很重要的。 - -在这里,我会试着将我在GitHub上学到的东西一一分享出来。 - -##我与GitHub的故事 - -在我大四找工作的时候,试图去寻找一份硬件、物联网相关的工作(ps: 专业是电子信息工程)。尽管简历上写得满满的各种经历、经验,然而并没有卵用。跑了几场校园招聘会后,十份简历(ps: 事先已经有心里准备)一个也没有投出去——因为学校直接被拒。我对霸面什么的一点兴趣都没有,千里马需要伯乐。后来,我加入了Martin Flower所在的公司,当然这是后话了。 - -这是一个残酷的世界,在学生时代,如果你长得不帅不高的话,那么多数的附加技能都是白搭(ps: 通常富的是看不到这篇文章的)。在工作时期,如果你上家没有名气,那么将会影响你下一份工作的待遇。而,很多东西却会改变这些,GitHub就是其中一个。 - -注册GitHub的时候大概是大一的时候,我熟悉的时候已经是大四了,现在已经毕业一年了。在过去的近两年里,我试着以几个维度在GitHub上创建项目: - -1. 快速上手框架来实战,即demo -2. 重构别人的代码 -3. 创建自己可用的框架 -4. 快速构建大型应用 -5. 构建通用的框架 - -###GitHub与收获 - -先说说**与技能无关的收获**吧,毕业设计做的是一个《[最小物联网系统](https://github.com/phodal/iot)》,考虑到我们专业老师没有这方面知识,答辩时会带来问题,尽量往这方面靠拢。当我毕业后,这个项目已经有过百个star了,这样易上手的东西还是比较受欢迎的(ps: 不过这种硬件相关的项目通常受限于GitHub上硬件开发工程师比较少的困扰)。 - -毕业后一个月收到PACKT出版社的邮件(ps: 他们是在github上找到我的),内容是关于Review一本[物联网](iot)书籍,即在《[从Review到翻译IT书籍](http://www.phodal.com/blog/review-it-books-with-translate-book/)》中提到的《Learning Internet of Things》。作为一个四级没过的"物联网专家",去审阅一本英文的物联网书籍。。。 - -当然,后来是审阅完了,书上有我的英文简介。 - -![Phodal Huang Introduction](./img/phodal-intro.jpg) - -一个月前,收到MANNING出版社的邮件(ps: 也是在github上),关于Review一本[物联网](iot)书籍的目录,并提出建议。 - -也因此带来了其他更多的东西,当然不是这里的主题。在这里,我们就不讨论各种骚扰邮件,或者中文合作。从没有想象过,我也可以在英语世界有一片小天地。 - -这些告诉我们,GitHub上找一个你擅长的主题,那么会有很多人找上你的。 - -###GitHub与成长 - -过去写过一篇《[如何通过github提升自己](http://www.phodal.com/blog/use-github-grow-self/)》的文章,现在只想说三点: - -1. 测试 -2. 更多的测试 -3. 更多的、更多的、更多的测试 - -没有测试的项目是很扯淡的,除非你的项目只有一个函数,然后那个函数返回``Hello,World``。 - -如果你的项目代码有上千行,如果你能保证测试覆盖率可以达到95%以的话,那么我想你的项目不会有太复杂的函数。假使有这样的函数,那么他也是被测试覆盖住的。 - -如果你在用心做这个项目,那么你看到代码写得不好也会试着改进,即重构。当有了一些,你的技能会不断提升。你开始会试着接触更多的东西,如stub,如mock,如fakeserver。 - -有一天,你会发现你离不开测试。 - -然后就会相信: **那些没有写测试的项目都是在耍流氓** - -##为什么你应该深入GitHub - -上面我们说的都是我们可以收获到的东西,我们开始尝试就意味着我们知道它可能给我们带来好处。上面已经提到很多可以提升自己的例子了,这里再说说其他的。 - -###方便工作 - -我们可以从中获取到不同的知识、内容、信息。每个人都可以从别人的代码中学习,当我们需要构建一个库的时候我们可以在上面寻找不同的库和代码来实现我们的功能。如当我在实现一个库的时候,我会在GitHub上到相应的组件: - -- Promise 支持 -- Class类(ps:没有一个好的类使用的方式) -- Template 一个简单的模板引擎 -- Router 用来控制页面的路由 -- Ajax 基本的Ajax Get/Post请求 - -###获得一份工作 - -越来越多的人因为GitHub获得工作,因为他们的做的东西正好符合一些公司的要求。那么,这些公司在寻找代码的时候,就会试着邀请他们。 - -因而,在GitHub寻找合适的候选人,已经是一种趋势。 - -###扩大交际 - -如果我们想创造出更好、强大地框架时,那么认识更多的人可能会带来更多的帮助。有时候会同上面那一点一样的效果 - ---- \ No newline at end of file diff --git a/chapters/01-start-project.md b/chapters/01-start-project.md new file mode 100644 index 0000000..6d246fb --- /dev/null +++ b/chapters/01-start-project.md @@ -0,0 +1,85 @@ +创建开源项目 +=== + +人们出于不同的目的来创建开源项目,可不论目的是什么,过程都是一样的。 + +1. 首先,我们需要为我们的项目取一个名字。 +2. 然后,为我们的开源项目选择一个合适的 LICENSE +3. 然后再去创建项目 + +取一个好的名字 +--- + +取名字,从来就不是一件容易的事。 + +因此,我就长话短说,一般就是取一个有意义的名字,当然没有意义也没有任何问题。 + +通常而言,如果自己计划有一系列的开源项目,那么我们可以保持一定的命名规则。 + +挑选好 LICENSE +--- + +> 在二十世纪而七十年代末和八十年代初,为了防止自己的软件被竞争对手所使用,大多数厂家停止分发其软件源代码,并开始使用版权和限制性软件许可证,来限制或者禁止软件源代码的复制或再分配。随后,Richard Matthew Stallman(Richard Matthew Stallman)发起了自由软件运动,他开创了 Copyleft 的概念:使用版权法的原则来保护使用、修改和分发自由软件的权利,并且是描述这些术语的自由软件许可证的主要作者。最为人所称道的是GPL(被广泛使用的自由软件协议)。[^rms] + +(PS:关于自由软件及 RMS 的更多信息、历史,可以阅读《若为自由故:自由软件之父 - 理查德 斯托曼传》) + +[^rms]: https://zh.wikipedia.org/wiki/%E7%90%86%E6%9F%A5%E5%BE%B7%C2%B7%E6%96%AF%E6%89%98%E6%9B%BC + +随后,便诞生了开源软件的概念,开源的要求比自由软件宽松一些[^gnu_gpl]。迄今发布的自由软件源代码都是开源软件,而并非所有的开源软件都是自由软件。这是因为不同的许可(协议)赋予用户不同的权利,如 GPL 协议强制要求开源修改过源码的代码,而宽松一点的 MIT 则不会有这种要求。 + +[^gnu_gpl]: https://www.gnu.org/philosophy/open-source-misses-the-point.zh-cn.html + +如下是不同开源许可证的市场占有率及使用情况。 + +![License 使用情况](../img/permissive-vs-copylift-license-2.jpg) + +又比如,在我们看到的一些外版书籍上,如果拥有代码。那么作者一般就会在前言或者类似的位置里,指明书中代码的版权所属。如: + +> 也许你需要在自己的程序或文档中用到本书的代码,但除非大篇幅地使用,否则不必与我们联系取得授权。例如,用本书中的几段代码编写程序无需请求许可,blabla。 + +于是,选择一个合理的 LICENSE,就变成了一个有趣的话题。为此,笔者做了一个如何进行开源协议选型的流程图: + +[![如何选择 License](../img/licenses.png)](https://github.com/phodal/licenses) + +简单地来说,这些 License 之间是一些权利的区别,如当你把代码放置到公有领域,就意味着任何人可以修改,并且不需要标明出注;可如果你想要别人标明出处及作者,你就需要 MIT 协议;而你希望别人闭源的话,那么你就需要 MPL 协议等等。 + +那么,下面让我们简单地介绍一下不同的几个协议。 + +### 公有领域 + +> WTFPL(Do What The Fuck You Want To Public License,中文译名:你他妈的想干嘛就干嘛公共许可证)是一种不太常用的、极度放任的自由软件许可证。它的条款基本等同于贡献到公有领域。[^wtfpl] + +[^wtfpl]: https://zh.wikipedia.org/wiki/WTFPL + +这就意味着,对于拿到这些代码的其他人,他们想怎么修改就可以怎么修改。 + +### GPL + +由于 GPL 的传染性,便意味着,他人引用我们的代码时,其所写的代码也需要使用 GPL 开源。即:GPL 是有 “传染性” 的 “病毒” ,因为 GPL 条款规定演绎作品也必须是 GPL 的。 + +而如果我们只针对的是,他人可以使用库,而不开源,则可以用 LGPL。但是修改库则不适用。 + +### MIT + +因此,一般而言,我使用的是 MIT 协议。至少我保留了一个署名权,即你可以修改我的代码,但是在 LICENSE 里必须加上我的名字。 + +选用 MIT 特别有意思,特别是在最近几年里,发生过: + + - [iView “抄袭” Element UI 事件](https://zhuanlan.zhihu.com/p/25739512) + - [AndroidTVLauncher “抄袭” 事件](https://github.com/JackyAndroid/AndroidTVLauncher/issues/22) + +等等。这告诫了我们,如果你不想要有这种经历,那么就不要用 MIT 了。 + +### Creative Commons + +是的,当我写 Markdown 的时候,考虑到未来会以纸质书的形式出现,便会使用 CC-BY-NC-ND 协议: + + - CC -> Creative Commons + - BY -> 署名(英语:Attribution,by) + - NC -> 非商业性使用(英语:NonCommercial) + - ND -> 禁止演绎(英语:NoDerivs)。 + +即,任何人可以使用我写的电子书来自由复制、散布、展示及演出,但是不得用于商业用途(作者本人可以)。它可以随意地放在他的博客上,他的各个文章里。但是必须标明出自,并且不得改变、转变或更改本作品。 + +如果你不介意的话,你可以使用公有领域(Public Domain)。可是这样一来,万一有一天,别人直接拿你的作品出书,你就骂爹了。 + diff --git a/chapters/02-github-fundamentals.md b/chapters/02-github-fundamentals.md index 70bcf07..61b6b41 100644 --- a/chapters/02-github-fundamentals.md +++ b/chapters/02-github-fundamentals.md @@ -1,40 +1,40 @@ -#Git基本知识与GitHub使用 +# Git 基本知识与 GitHub 使用 -##Git +## Git -从一般开发者的角度来看,git有以下功能: +从一般开发者的角度来看,Git 有以下功能: 1. 从服务器上克隆数据库(包括代码和版本信息)到单机上。 2. 在自己的机器上创建分支,修改代码。 3. 在单机上自己创建的分支上提交代码。 4. 在单机上合并分支。 -5. 新建一个分支,把服务器上最新版的代码fetch下来,然后跟自己的主分支合并。 +5. 新建一个分支,把服务器上最新版的代码 fetch 下来,然后跟自己的主分支合并。 6. 生成补丁(patch),把补丁发送给主开发者。 7. 看主开发者的反馈,如果主开发者发现两个一般开发者之间有冲突(他们之间可以合作解决的冲突),就会要求他们先解决冲突,然后再由其中一个人提交。如果主开发者可以自己解决,或者没有冲突,就通过。 -8. 一般开发者之间解决冲突的方法,开发者之间可以使用pull 命令解决冲突,解决完冲突之后再向主开发者提交补丁。 +8. 一般开发者之间解决冲突的方法,开发者之间可以使用 pull 命令解决冲突,解决完冲突之后再向主开发者提交补丁。 -从主开发者的角度(假设主开发者不用开发代码)看,git有以下功能: +从主开发者的角度(假设主开发者不用开发代码)看,Git 有以下功能: 1. 查看邮件或者通过其它方式查看一般开发者的提交状态。 2. 打上补丁,解决冲突(可以自己解决,也可以要求开发者之间解决以后再重新提交,如果是开源项目,还要决定哪些补丁有用,哪些不用)。 3. 向公共服务器提交结果,然后通知所有开发人员。 -###Git初入 +### Git 初入 -如果是第一次使用Git,你需要设置署名和邮箱: +如果是第一次使用 Git,你需要设置署名和邮箱: ``` $ git config --global user.name "用户名" $ git config --global user.email "电子邮箱" ``` -将代码仓库clone到本地,其实就是将代码复制到你的机器里,并交由Git来管理: +将代码仓库 clone 到本地,其实就是将代码复制到你的机器里,并交由 Git 来管理: ``` $ git clone git@github.com:someone/symfony-docs-chs.git ``` -你可以修改复制到本地的代码了(symfony-docs-chs项目里都是rst格式的文档)。当你觉得完成了一定的工作量,想做个阶段性的提交: +你可以修改复制到本地的代码了(symfony-docs-chs 项目里都是 rst 格式的文档)。当你觉得完成了一定的工作量,想做个阶段性的提交: 向这个本地的代码仓库添加当前目录的所有改动: @@ -56,28 +56,28 @@ $git status 来看现在的状态,如下图是添加之前的: -![Before add](./img/before-add.png) +![Before add](../img/before-add.png) 下面是添加之后 的 -![After add](./img/after-add.png) +![After add](../img/after-add.png) -可以看到状态的变化是从黄色到绿色,即unstage到add。 +可以看到状态的变化是从黄色到绿色,即 unstage 到 add。 -##GitHub +## GitHub -Wiki百科上是这么说的 +Wiki 百科上是这么说的 > GitHub 是一个共享虚拟主机服务,用于存放使用Git版本控制的软件代码和内容项目。它由GitHub公司(曾称Logical Awesome)的开发者Chris Wanstrath、PJ Hyett和Tom Preston-Werner 使用Ruby on Rails编写而成。 -当然让我们看看官方的介绍: +当然让我们看看官方的介绍: > GitHub is the best place to share code with friends, co-workers, classmates, and complete strangers. Over eight million people use GitHub to build amazing things together. -它还是什么? +它还是什么? - 网站 - 免费博客 @@ -88,11 +88,11 @@ Wiki百科上是这么说的 - 托管编程环境 - 写作 -等等。看上去像是大餐,但是你还需要了解点什么? +等等。看上去像是大餐,但是你还需要了解点什么? -###版本管理与软件部署 +### 版本管理与软件部署 -jQuery[^jQuery]在发布版本``2.1.3``,一共有152个commit。我们可以看到如下的提交信息: +jQuery[^jQuery] 在发布版本``2.1.3``,一共有 152 个 commit。我们可以看到如下的提交信息: - Ajax: Always use script injection in globalEval … bbdfbb4 - Effects: Reintroduce use of requestAnimationFrame … 72119e0 @@ -101,23 +101,23 @@ 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这样的部署工具所使用。 > GitHub可以托管各种git库,并提供一个web界面,但与其它像 SourceForge或Google Code这样的服务不同,GitHub的独特卖点在于从另外一个项目进行分支的简易性。为一个项目贡献代码非常简单:首先点击项目站点的“fork”的按钮,然后将代码检出并将修改加入到刚才分出的代码库中,最后通过内建的“pull request”机制向项目负责人申请代码合并。已经有人将GitHub称为代码玩家的MySpace。 -###在GitHub创建项目 +### 在 GitHub 创建项目 -接着,我们试试在上面创建一个项目: +接着,我们试试在上面创建一个项目: -![GitHub Roam](./img/github-roam-create.jpg) +![GitHub Roam](../img/github-roam-create.jpg) -就会有下面的提醒: +就会有下面的提醒: -![GitHub Roam](./img/project-init.jpg) +![GitHub Roam](../img/project-init.jpg) -它提供多种方式的创建方法: +它提供多种方式的创建方法: > …or create a new repository on the command line @@ -139,9 +139,9 @@ git push -u origin master 如果你完成了上面的步骤之后,那么我想你想知道你需要怎样的项目。 -##GitHub流行项目分析 +## GitHub 流行项目分析 -之前曾经分析过一些GitHub的用户行为,现在我们先来说说GitHub上的Star吧。(截止: 2015年3月9日23时。) +之前曾经分析过一些 GitHub 的用户行为,现在我们先来说说 GitHub 上的 Star 吧。(截止:2015年3月9日23时。) 用户 | 项目名 | Language | Star | Url -----|---------- |----------|------|---- @@ -151,7 +151,7 @@ angular | angular.js | JavaScript | 36,061 | [https://github.com/angular/angular mbostock | d3 | JavaScript | 35,257 | [https://github.com/mbostock/d3](https://github.com/mbostock/d3) joyent | node | JavaScript | 35,077 | [https://github.com/joyent/node](https://github.com/joyent/node) -上面列出来的是前5的,看看大于1万个stars的项目的分布,一共有82个: +上面列出来的是前5的,看看大于 1 万个 Stars 的项目的分布,一共有 82 个: 语言 | 项目数 -----|----- @@ -166,24 +166,24 @@ Shell | 2 Go | 2 C | 2 -类型分布: +类型分布: - - 库和框架: 如``jQuery`` - - 系统: 如``Linux``、``hhvm``、``docker`` - - 配置集: 如``dotfiles`` - - 辅助工具: 如``oh-my-zsh`` - - 工具: 如``Homewbrew``和``Bower`` - - 资料收集: 如``free programming books``,``You-Dont-Know-JS``,``Font-Awesome`` - - 其他:简历如``Resume`` + - 库和框架:如``jQuery`` + - 系统:如``Linux``、``hhvm``、``docker`` + - 配置集:如``dotfiles`` + - 辅助工具:如``oh-my-zsh`` + - 工具:如``Homewbrew``和``Bower`` + - 资料收集:如``free programming books``,``You-Dont-Know-JS``,``Font-Awesome`` + - 其他:简历如``Resume`` -##Pull Request +## Pull Request -除了创建项目之外,我们也可以创建Pull Request来做贡献。 +除了创建项目之外,我们也可以创建 Pull Request 来做贡献。 -###我的第一个PR +### 我的第一个 PR -我的第一个PR是给一个小的Node的CoAP相关的库的Pull Request。原因比较简单,是因为它的README.md写错了,导致我无法办法进行下一步。 +我的第一个 PR 是给一个小的 Node 的 CoAP 相关的库的 Pull Request。原因比较简单,是因为它的 README.md 写错了,导致我无法进行下一步。 const dgram = require('dgram') - , coapPacket = require('coap-packet') @@ -202,18 +202,16 @@ C | 2 fi ``` -###CLA +### CLA -CLA即Contributor License Agreement,在为一些大的组织、机构提交Pull Request的时候,可能需要签署这个协议。他们会在你的Pull Request里问你,只有你到他们的网站去注册并同意协议才会接受你的PR。 +CLA 即 Contributor License Agreement,在为一些大的组织、机构提交 Pull Request 的时候,可能需要签署这个协议。他们会在你的 Pull Request 里问你,只有你到他们的网站去注册并同意协议才会接受你的 PR。 -以下是我为Google提交的一个PR +以下是我为 Google 提交的一个 PR -![Google CLA](./img/google-cla.png) +![Google CLA](../img/google-cla.png) -以及Eclipse的一个PR +以及 Eclipse 的一个 PR -![Eclipse CLA](./img/eclipse-cla.png) +![Eclipse CLA](../img/eclipse-cla.png) -他们都要求我签署CLA。 - -
+他们都要求我签署 CLA。 diff --git a/chapters/03-build-github-project.md b/chapters/03-build-github-project.md index 14cdf81..ce80ac8 100644 --- a/chapters/03-build-github-project.md +++ b/chapters/03-build-github-project.md @@ -1,27 +1,27 @@ -#构建GitHub项目 +# 构建 GitHub 项目 -##如何用好GitHub +## 如何用好 GitHub -如何用好GitHub,并实践一些敏捷软件开发是一个很有意思的事情.我们可以在上面做很多事情,从测试到CI,再到自动部署. +如何用好 GitHub,并实践一些敏捷软件开发是一个很有意思的事情.我们可以在上面做很多事情,从测试到 CI,再到自动部署. -###敏捷软件开发 +### 敏捷软件开发 -显然我是在扯淡,这和敏捷软件开发没有什么关系。不过我也不知道瀑布流是怎样的。说说我所知道的一个项目的组成吧: +显然我是在扯淡,这和敏捷软件开发没有什么关系。不过我也不知道瀑布流是怎样的。说说我所知道的一个项目的组成吧: - - 看板式管理应用程序(如trello,简单地说就是管理软件功能) - - CI(持续集成) + - 看板式管理应用程序(如 trello,简单地说就是管理软件功能) + - CI(持续集成) - 测试覆盖率 - - 代码质量(code smell) + - 代码质量(code smell) -对于一个不是远程的团队(如只有一个人的项目) 来说,Trello、Jenkin、Jira不是必需的: +对于一个不是远程的团队(如只有一个人的项目)来说,Trello、Jenkin、Jira不是必需的: > 你存在,我深深的脑海里 -当只有一个人的时候,你只需要明确知道自己想要什么就够了。我们还需要的是CI、测试,以来提升代码的质量。 +当只有一个人的时候,你只需要明确知道自己想要什么就够了。我们还需要的是 CI、测试,以来提升代码的质量。 -###测试 +### 测试 -通常我们都会找Document,如果没有的话,你会找什么?看源代码,还是看测试? +通常我们都会找 Document,如果没有的话,你会找什么?看源代码,还是看测试? ```javascript it("specifying response when you need it", function (done) { @@ -43,17 +43,17 @@ it("specifying response when you need it", function (done) { }); ``` -代码来源: [https://github.com/phodal/lettuce](https://github.com/phodal/lettuce) +代码来源:[https://github.com/phodal/lettuce](https://github.com/phodal/lettuce) 上面的测试用例,清清楚楚地写明了用法,虽然写得有点扯。 -等等,测试是用来干什么的。那么,先说说我为什么会想去写测试吧: +等等,测试是用来干什么的。那么,先说说我为什么会想去写测试吧: - - 我不希望每次做完一个个新功能的时候,再手动地去测试一个个功能。(自动化测试) + - 我不希望每次做完一个个新功能的时候,再手动地去测试一个个功能。(自动化测试) - 我不希望在重构的时候发现破坏了原来的功能,而我还一无所知。 - 我不敢push代码,因为我没有把握。 -虽然,我不是TDD的死忠,测试的目的是保证功能正常,TDD没法让我们写出质量更高的代码。但是有时TDD是不错的,可以让我们写出逻辑更简单地代码。 +虽然,我不是 TDD 的死忠,测试的目的是保证功能正常,TDD 没法让我们写出质量更高的代码。但是有时TDD是不错的,可以让我们写出逻辑更简单地代码。 也许你已经知道了``Selenium``、``Jasmine``、``Cucumber``等等的框架,看到过类似于下面的测试 @@ -71,7 +71,7 @@ it("specifying response when you need it", function (done) { ✓ should be able fadeout elements ``` -代码来源: [https://github.com/phodal/lettuce](https://github.com/phodal/lettuce) +代码来源:[https://github.com/phodal/lettuce](https://github.com/phodal/lettuce) 看上去似乎每个测试都很小,不过补完每一个测试之后我们就得到了测试覆盖率 @@ -81,9 +81,9 @@ 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``示例: +虽然 node.js 不算是一门语言,但是因为我们用的 node,下面的是一个简单的 ``.travis.yml`` 示例: ```yml language: node_js @@ -98,23 +98,23 @@ install: npm install after_success: CODECLIMATE_REPO_TOKEN=321480822fc37deb0de70a11931b4cb6a2a3cc411680e8f4569936ac8ffbb0ab codeclimate < coverage/lcov.info ``` -代码来源: [https://github.com/phodal/lettuce](https://github.com/phodal/lettuce) +代码来源:[https://github.com/phodal/lettuce](https://github.com/phodal/lettuce) -我们把这些集成到``README.md``之后,就有了之前那张图。 +我们把这些集成到 ``README.md`` 之后,就有了之前那张图。 CI对于一个开发者在不同城市开发同一项目上来说是很重要的,这意味着当你添加的部分功能有测试覆盖的时候,项目代码会更加强壮。 -###代码质量 +### 代码质量 -像``jslint``这类的工具,只能保证代码在语法上是正确的,但是不能保证你写了一堆bad smell的代码。 +像 ``jslint`` 这类的工具,只能保证代码在语法上是正确的,但是不能保证你写了一堆 bad smell 的代码。 - 重复代码 - 过长的函数 - 等等 -``Code Climate``是一个与github集成的工具,我们不仅仅可以看到测试覆盖率,还有代码质量。 +``Code Climate`` 是一个与 GitHub 集成的工具,我们不仅仅可以看到测试覆盖率,还有代码质量。 -先看看上面的ajax类: +先看看上面的 ajax 类: ```javascript Lettuce.get = function (url, callback) { @@ -141,9 +141,9 @@ Lettuce.send = function (url, method, callback, data) { }; ``` -代码来源: [https://github.com/phodal/lettuce](https://github.com/phodal/lettuce) +代码来源:[https://github.com/phodal/lettuce](https://github.com/phodal/lettuce) -在[Code Climate](https://codeclimate.com/github/phodal/lettuce/src/ajax.js)在出现了一堆问题 +在 [Code Climate](https://codeclimate.com/github/phodal/lettuce/src/ajax.js) 在出现了一堆问题 - Missing "use strict" statement. (Line 2) - Missing "use strict" statement. (Line 14) @@ -155,51 +155,51 @@ Lettuce.send = function (url, method, callback, data) { 这就意味着我们可以对上面的代码进行重构,他们是重复的代码。 -##模块分离与测试 +## 模块分离与测试 在之前说到 -> 奋斗了近半个月后,将fork的代码读懂、重构、升级版本、调整,添加新功能、添加测试、添加CI、添加分享之后,终于almost finish。 +> 奋斗了近半个月后,将 fork 的代码读懂、重构、升级版本、调整,添加新功能、添加测试、添加 CI、添加分享之后,终于 almost finish。 今天就来说说是怎样做的。 -以之前造的[Lettuce](https://github.com/phodal/lettuce)为例,里面有: +以之前造的 [Lettuce](https://github.com/phodal/lettuce) 为例,里面有: - - 代码质量(Code Climate) - - CI状态(Travis CI) - - 测试覆盖率(96%) - - 自动化测试(npm test) + - 代码质量(Code Climate) + - CI状态(Travis CI) + - 测试覆盖率(96%) + - 自动化测试(npm test) - 文档 -按照[Web Developer路线图](https://github.com/phodal/awesome-developer)来说,我们还需要有: +按照 [Web Developer 路线图](https://github.com/phodal/awesome-developer)来说,我们还需要有: - 版本管理 - 自动部署 等等。 -###代码模块化 +### 代码模块化 -在SkillTree的源码里,大致分为三部分: +在 SkillTree 的源码里,大致分为三部分: - - namespace函数: 顾名思义 - - Calculator也就是TalentTree,主要负责解析、生成url,头像,依赖等等 - - Skill 主要是tips部分。 + - namespace 函数:顾名思义 + - Calculator 也就是 TalentTree,主要负责解析、生成 url,头像,依赖等等 + - Skill 主要是 tips 部分。 -而这一些都在一个js里,对于一个库来说,是一件好事,但是对于一个项目来说,并非如此。 +而这一些都在一个 JS 里,对于一个库来说,是一件好事,但是对于一个项目来说,并非如此。 依赖的库有 - jQuery - Knockout -好在Knockout可以用Require.js进行管理,于是,使用了``Require.js``进行管理: +好在 Knockout 可以用 Require.js 进行管理,于是,使用了 ``Require.js`` 进行管理: ```html ``` -``main.js``配置如下: +``main.js`` 配置如下: ```javascript require.config({ @@ -220,7 +220,7 @@ require(['lib/knockout', 'scripts/TalentTree', 'json!data/web.json'], function(k }); ``` -text、json插件主要是用于处理web.json,即用json来处理技能,于是不同的类到了不同的js文件。 +text、JSON 插件主要是用于处理 web.json,即用 JSON 来处理技能,于是不同的类到了不同的 JS 文件。 . |____Book.js @@ -232,7 +232,7 @@ text、json插件主要是用于处理web.json,即用json来处理技能,于 |____TalentTree.js |____Utils.js -加上了后来的推荐阅读书籍等等。而Book和Link都是继承自Doc。 +加上了后来的推荐阅读书籍等等。而 Book 和 Link 都是继承自 Doc。 ```javascript define(['scripts/Doc'], function(Doc) { @@ -246,7 +246,7 @@ define(['scripts/Doc'], function(Doc) { }); ``` -而这里便是后面对其进行重构的内容。Doc类则是Skillock中类的一个缩影 +而这里便是后面对其进行重构的内容。Doc 类则是 Skillock 中类的一个缩影 ```javascript define([], function() { @@ -263,7 +263,7 @@ define([], function() { }); ``` -或者说这是一个AMD的Class应该有的样子。考虑到this的隐性绑定,作者用了self=this来避免这个问题。最后Return了这个对象,我们在调用的就需要new一个。大部分在代码中返回的都是对象,除了在Utils类里面返回的是函数: +或者说这是一个 AMD 的 Class 应该有的样子。考虑到 this 的隐性绑定,作者用了self=this 来避免这个问题。最后 Return 了这个对象,我们在调用的就需要 new 一个。大部分在代码中返回的都是对象,除了在 Utils 类里面返回的是函数: ```javascript return { @@ -275,9 +275,9 @@ return { 当然函数也是一个对象。 -###自动化测试 +### 自动化测试 -一直习惯用Travis CI,于是也继续用Travis Ci,``.travis.yml``配置如下所示: +一直习惯用 Travis CI,于是也继续用 Travis Ci,``.travis.yml`` 配置如下所示: ```yml language: node_js @@ -292,9 +292,9 @@ branches: - gh-pages ``` -使用gh-pages的原因是,我们一push代码的时候,就可以自动测试、部署等等,好处一堆堆的。 +使用 gh-pages 的原因是,我们一 push 代码的时候,就可以自动测试、部署等等,好处一堆堆的。 -接着我们需要在``package.json``里面添加脚本 +接着我们需要在 ``package.json`` 里面添加脚本 ```javascript "scripts": { @@ -302,7 +302,7 @@ branches: } ``` -这样当我们push代码的时候便会自动跑所有的测试。因为mocha的主要配置是用``mocha.opts``,所以我们还需要配置一下``mocha.opts`` +这样当我们 push 代码的时候便会自动跑所有的测试。因为 mocha 的主要配置是用 ``mocha.opts``,所以我们还需要配置一下 ``mocha.opts`` --reporter spec --ui bdd @@ -310,25 +310,25 @@ branches: --colors test/spec -最后的``test/spec``是指定测试的目录。 +最后的 ``test/spec`` 是指定测试的目录。 -###Jshint +### JSLint > JSLint定义了一组编码约定,这比ECMA定义的语言更为严格。这些编码约定汲取了多年来的丰富编码经验,并以一条年代久远的编程原则 作为宗旨:能做并不意味着应该做。JSLint会对它认为有的编码实践加标志,另外还会指出哪些是明显的错误,从而促使你养成好的 JavaScript编码习惯。 -当我们的js写得不合理的时候,这时测试就无法通过: +当我们的 JS 写得不合理的时候,这时测试就无法通过: line 5 col 25 A constructor name should start with an uppercase letter. line 21 col 62 Strings must use singlequote. -这是一种驱动写出更规范js的方法。 +这是一种驱动写出更规范 JS 的方法。 -###Mocha +### Mocha > Mocha 是一个优秀的JS测试框架,支持TDD/BDD,结合 should.js/expect/chai/better-assert,能轻松构建各种风格的测试用例。 -最后的效果如下所示: +最后的效果如下所示: Book,Link Book Test @@ -336,9 +336,9 @@ branches: Link Test ✓ should return link label & url -###测试示例 +### 测试示例 -简单地看一下Book的测试: +简单地看一下 Book 的测试: ```javascript /* global describe, it */ @@ -377,7 +377,7 @@ describe('Book,Link', function () { }); ``` -因为我们用``require.js``来管理浏览器端,在后台写测试来测试的时候,我们也需要用他来管理我们的依赖,这也就是为什么这个测试这么长的原因,多数情况下一个测试类似于这样子的。(用Jasmine似乎会是一个更好的主意,但是用习惯Jasmine了) +因为我们用 ``require.js`` 来管理浏览器端,在后台写测试来测试的时候,我们也需要用他来管理我们的依赖,这也就是为什么这个测试这么长的原因,多数情况下一个测试类似于这样子的。(用 Jasmine 似乎会是一个更好的主意,但是用习惯 Jasmine 了) ```javascript describe('Book Test', function () { @@ -398,46 +398,45 @@ it('should return book label & url', function () { 最后的断言,也算是测试的核心,保证测试是有用的。 -##代码质量与重构 +## 代码质量与重构 - 当你写了一大堆代码,你没有意识到里面有一大堆重复。 - 当你写了一大堆测试,却不知道覆盖率有多少。 -这就是个问题了,于是偶然间看到了一个叫code climate的网站。 +这就是个问题了,于是偶然间看到了一个叫 code climate 的网站。 -###Code Climate +### Code Climate > Code Climate consolidates the results from a suite of static analysis tools into a single, real-time report, giving your team the information it needs to identify hotspots, evaluate new approaches, and improve code quality. -Code Climate整合一组静态分析工具的结果到一个单一的,实时的报告,让您的团队需要识别热点,探讨新的方法,提高代码质量的信息。 +Code Climate 整合一组静态分析工具的结果到一个单一的,实时的报告,让您的团队需要识别热点,探讨新的方法,提高代码质量的信息。 -简单地来说: +简单地来说: - 对我们的代码评分 - 找出代码中的坏味道 于是,我们先来了个例子 -Rating | Name | Complexity | Duplication | Churn | C/M | Coverage | Smells ---------|------|--------------|-------------|----------|---------|--------------------- -A | lib/coap/coap_request_handler.js | 24 | 0 | 6 | 2.6 | 46.4% | 0 -A | lib/coap/coap_result_helper.js | 14 | 0 | 2 | 3.4 | 80.0% | 0 -A | lib/coap/coap_server.js | 16 | 0 | 5 | 5.2 | 44.0% | 0 -A | lib/database/db_factory.js | 8 | 0 | 3 | 3.8 | 92.3% | 0 -A | lib/database/iot_db.js | 7 | 0 | 6 | 1.0 | 58.8% | 0 -A | lib/database/mongodb_helper.js | 63 | 0 | 11 | 4.5 | 35.0% | 0 -C | lib/database/sqlite_helper.js | 32 | 86 | 10 | 4.5 | 35.0% | 2 -B | lib/rest/rest_helper.js | 19 | 62 | 3 | 4.7 | 37.5% | 2 -A | lib/rest/rest_server.js | 17 | 0 | 2 | 8.6 | 88.9% | 0 -A | lib/url_handler.js | 9 | 0 | 5 | 2.2 | 94.1% | 0 - -分享得到的最后的结果是: +| Rating | Name | Complexity | Duplication | Churn | C/M | Coverage | Smells | +| ------ | -------------------------------- | ---------- | ----------- | ----- | ---- | -------- | ------ | +| A | lib/coap/coap_request_handler.js | 24 | 0 | 6 | 2.6 | 46.4% | 0 | +| A | lib/coap/coap_result_helper.js | 14 | 0 | 2 | 3.4 | 80.0% | 0 | +| A | lib/coap/coap_server.js | 16 | 0 | 5 | 5.2 | 44.0% | 0 | +| A | lib/database/db_factory.js | 8 | 0 | 3 | 3.8 | 92.3% | 0 | +| A | lib/database/iot_db.js | 7 | 0 | 6 | 1.0 | 58.8% | 0 | +| A | lib/database/mongodb_helper.js | 63 | 0 | 11 | 4.5 | 35.0% | 0 | +| C | lib/database/sqlite_helper.js | 32 | 86 | 10 | 4.5 | 35.0% | 2 | +| B | lib/rest/rest_helper.js | 19 | 62 | 3 | 4.7 | 37.5% | 2 | +| A | lib/rest/rest_server.js | 17 | 0 | 2 | 8.6 | 88.9% | 0 | + +分享得到的最后的结果是: ![Coverage][1] -###代码的坏味道 +### 代码的坏味道 -于是我们就打开``lib/database/sqlite_helper.js``,因为其中有两个坏味道 +于是我们就打开 ``lib/database/sqlite_helper.js``,因为其中有两个坏味道 Similar code found in two :expression_statement nodes (mass = 86) @@ -539,5 +538,3 @@ SQLiteHelper.prototype.getData = function (url, callback) { ``` 重构完后的代码比原来还长,这似乎是个问题~~ - - --- diff --git a/chapters/04-commit-message.md b/chapters/04-commit-message.md new file mode 100644 index 0000000..ac323bb --- /dev/null +++ b/chapters/04-commit-message.md @@ -0,0 +1,94 @@ +Git 提交信息及几种不同的规范 +=== + +> 受 Growth 3.0 开发的影响,最近更新文章的频率会有所降低。今天,让我们来谈谈一个好的 Git、SVN 提交信息是怎样规范出来的。 + +在团队协作中,使用版本管理工具 Git、SVN 几乎都是这个行业的标准。当我们提交代码的时候,需要编写提交信息(commit message)。 + +而提交信息的主要用途是:**告诉这个项目的人,这次代码提交里做了些什么**。如,我更新了 React Native Elements 的版本,那么它就可以是:``[T] upgrade react native elements``。对应的我修改的代码就是:``package.json`` 和 ``yarn.lock`` 中的文件。一般来说,建议**小步提交**,即按自己的 Tasking 步骤来的提交,每一小步都有对应的提交信息。这样做的主要目的是:**防止一次修改中,修改过多的文件,导致后期修改、维护、撤销等等困难**。 + +而对于不同的团队来说,都会遵循一定的规范,本文主要会介绍以下几种写法: + + - 工作写法 + - 常规写法 + - 开源库写法 + +那么,先从我习惯的做法说起。 + +工作写法 +--- + +在我的第一个项目里,我们使用 Jira 作为看板工具,Bamboo 作为持续集成服务器,并采用结对编程的方式进行。 + +在 Jira 里每一个功能卡都有对应的卡号,而 Bamboo 支持使用 Jira 的任务卡号关联的功能。即在持续构建服务器上示例对应的任务卡号,即相应的提交人。 + +因此,这个时候我们的规范稍微有一些特别: + +``` +[任务卡号] xx & xx: do something +``` + +比如:``[PHODAL-0001] ladohp & phodal: update documents``,解释如下: + + - ``PHODAL-0001``,业务的任务卡号,它可以帮我们找到某个业务修改的原因,即点出相应 bug 的来源 + - ``ladohp & phodal`` ,结对编程的两个人的名字,后者(phodal)一般是写代码的人,出于礼貌就放在后面了。由于 Git 的提交人只显示一个,所以写上两个的名字。当提交的人不在时,就可以问另外一个人修改的原因。 + - ``update documents``,我们做了什么事情 + +缺点:而对于采用看板的团队来说,并不存在任务卡号这种东西,因此就需要一种额外的作法。 + +常规写法 +--- + +对于我来说,我则习惯这种的写法: + +``` +[任务分类] 主要修改组件(可选):修改内容 +``` + +示例 1,``[T] tabs: add icons`` 。其中的 ``T`` 表示这是一个技术卡,``tabs`` 表示修改的是 Tabs,``add icons`` 则表示添加了图标。 + +示例 2,``[SkillTree] detail: add link data``。其中的 ``SkillTree`` 表示修改的是技能树 Tab 下的内容,``detail`` 则表示修改的是详情页,``add link data`` 则表示是添加了技能的数据 + +这样做的主要原因是,它可以轻松也帮我 **filter 出相应业务的内容**。 + +缺点:要这样做需要团队达到一致,因此付出一些额外的成本。 + +开源应用、开源库写法 +--- + +与我们日常工作稍有不同的是:工作中的 Release 计划一般都是事先安排好的,不需要一些 CHANGELOG 什么的。而开源应用、开源库需要有对应的 CHANGELOG,则添加了什么功能、修改了什么等等。毕竟有很多东西是由社区来维护的。 + +因此,这里以做得比较好的开源项目 Angular 为例展示。Angular 团队建议采用以下的形式: + +``` +(): + + + +