Contribute checker for error-prone

入门

我们使用Maven构建系统。我们正在使用版本3. 下载Maven

我们使用OpenJDK 7和8进行测试，因此目前推荐使用。你的系统需要使用其中任何一个JDK。

构建库：

$ cd error-prone
$ mvn package

您还需要将IDE配置为使用受支持的JDK进行构建。

您的IDE的Maven插件应该非常方便地安装项目，git插件可以简化源代码管理。核心开发人员使用IntelliJ IDEA或Eclipse。

这非常有用，建议您定位JDK的源代码并将其附加到IDE中，这样您就可以在需要时导航到javac库中。

我们一般遵循Sun编码风格，每行限制100个字符。

写一个检查器

你想写一个检查器，并将其贡献给项目。以下是您应该遵循的步骤:

设置你的工作环境

按照上述入门步骤。然后创建一个分支，在其中做你的工作。

您还应该将check添加到问题跟踪器（如果还没有），评论你正在解决这个问题，并将状态从“New”更改为“Accepted”。

IDE配置

Eclipse

我们建议安装m2e-apt插件，并启用preferences > maven > annotation processing，因此AutoValue将自动运行。

Intellij

我们提供符合Google Java风格的intellij代码样式：

要安装它，将GoogleStyle.xml复制到您的intellij配置目录（例如〜/.IntelliJIdea14/config/codestyles/ for linux上的intellij 14，或者〜/Library/Preferences/IdeaIC14/codestyles/ for macell上的intellij 14）。
然后在Settings > Editor > Code Style中选择“Google样式”。

写你的检查器

Checkers在包com.google.errorprone.bugpatterns中。您可以按照本教程编写一个检查。别忘了写测试！

请求代码审查

error-prone的团队的成员需要检查您的代码并将其合并到主线项目中。我们使用github进行代码审查。

参考链接: For-Developers