进行修改

如果您正在考虑改进Karma，或者只是想对其进行修改，那太好了！以下是如何设置Karma工作区以及如何发送良好的拉取请求的一些提示。

设置工作区 #

  • 确保您拥有一个GitHub 账户。
  • 在GitHub上fork仓库。
  • 克隆您的fork
    $ git clone https://github.com/<your-username>/karma.git
$ cd karma
  • 安装开发依赖
    $ npm install

测试和构建 #

  • 通过以下命令运行测试

    $ npm test
# or you can run test suits individually
$ npm run test:unit
$ npm run test:e2e
$ npm run test:client

  • 通过以下命令检查代码风格

    $ npm run lint
# or you can also apply auto-fixes where possible
$ npm run lint:fix

  • 通过以下命令构建客户端代码

    $ npm run build
# or use the watch mode
$ npm run build:watch

修改代码 #

检出一个新分支，并根据您打算执行的操作为其命名

  • 功能分支以feature-为前缀。
  • Bug修复分支以fix-为前缀。
  • 文档改进分支以docs-为前缀。
    $ git checkout -b <branch_name>

打开您喜欢的编辑器，进行一些更改，运行测试，更改代码，运行测试，更改代码，运行测试，等等。

发送拉取请求 #

  • 提交您的更改（请遵循提交信息约定）
    $ git commit -m "..."
  • 验证最后一次提交是否遵循约定
    $ npm run commit:check
  • 推送到您的GitHub仓库
    $ git push origin <branch_name>
  • 转到GitHub页面，然后点击“打开拉取请求”。
  • 编写对更改的良好描述。

发送拉取请求后，其他开发人员将审查并讨论您的更改。请解决所有评论。一旦一切顺利，维护人员之一将合并您的更改。

贡献者许可协议 #

在发送拉取请求之前，请签署我们的贡献者许可协议 (CLA)。为了接受任何代码更改，必须签署CLA。这是一个快速的过程，我们保证！

其他资源 #