如何通过GitHub提升自己

jopen 10年前

如果我们仅仅是将自己的代码commit、push到github上,那么我们对于我们的技术不会有太多的提升。我们所做的仅仅只是将github当成了我们的网盘。

每发布一个版本的时候,是不是也就意味着给用户一个新的版本——持续交付。

如何通过GitHub提升自己

对应的badge分别是:

  • CI状态(Travic-CI)
  • 代码质量(0~4.0)(Code Climate)
  • 测试覆盖率(Code Climate)

于是,这个库的状态就很清楚了。(ps: 看上去,我就是这一堆工具的广告代理商,可惜他们都是免费的。)

敏捷软件开发

显然我是在扯淡,这和敏捷软件开发没有什么关系。不过我也不知道瀑布流是怎样的。说说,我所知道的一个项目的组成:

  • 看板式管理应用程序(如trello,简单地说就是管理软件功能)
  • CI(持续集成)
  • 测试覆盖率
  • 代码质量(code smell)

对于一个没有远程团队(如只有一个人的项目) 来说,Trello、Jenkin、Jira不是必需的:

> 你存在,我深深的脑海里

只有一个人的时候,只需要明确知道自己想要什么就够了。我们还需要的是CI、测试,以来提升代码的质量。

测试

通常我们都会去找Document,如果没有的话,你会找什么?看源代码,还是看测试?

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

上面的测试用例,清清楚楚的写明了用法,虽然写得有点扯。

等等,测试是用来干什么的。先说说我为什么会想去写测试:

  • 我不想每次做完一个个新功能的时候,再手动地去测试一个个功能。(自动化测试)
  • 我不想在重构的时候发现破坏了原来的功能,而我还一无所知。
  • 我不敢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

看上去似乎每个测试都很小,补完一个个的测试我们就会得到了测试覆盖率

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示例:

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

我们把这些集成到README.md之后,就有了之前那张图。

CI对于一个开发者在不同城市的项目来说是很重要的,这意味着当你添加的功能有测试覆盖的时候,项目代码会更加强壮。

代码质量

像jslint这类的工具,只能保证代码在语法上是正确的,但是不能保证你写了一堆bad smell的代码。

  • 重复代码
  • 过长的函数
  • 等等

Code Climate是一个与github集成的工具,我们不仅仅可以看到测试覆盖率,还有代码质量。

先看看上面的ajax类:

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

Code Climate在出现了一堆问题

  • 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的《重构》一书去了解一些重构的细节。

这时想说的是,只有代码被测试覆盖住了,那么才能保证重构的过程没有出错。

如何通过github提升

上面所说的只是一堆堆地工具,以及一堆堆的方法,真正需要的是实践。

我们需要有测试,有CI,这样我们才能提高自己。

来自:http://www.phodal.com/blog/use-github-grow-self/