Apache IoTDB贡献指南

[MinaQin]

Apache IoTDB贡献指南

欢迎来到开源摘星计划-Apache IoTDB贡献专栏 。Apache IoTDB已加入开源摘星计划，该计划提供奖励以鼓励你加入我们的社区：所有参与本项目贡献的开发者都可获得相应贡献积分、奖励以及被评选为年度摘星100 人的机会，活动及奖励详情请见：开源摘星计划。

📅活动时间：2022年5月-12月

🌟关于 Apache IoTDB

Apache IoTDB（物联网数据库）是一款高吞吐、高压缩、高可用、支持存储、管理与分析的物联网原生开源时序数据库系统软件。IoTDB 提出了轻量式端边云协同架构、独创物联网数据模型、自研时序存储文件格式，提供纳秒级采样数据写入、TB级数据毫秒级查询、数十倍数据无损压缩存储，支持丰富的时序数据查询操作，并与Apache Hadoop、Spark和Flink等进行了深度集成，以满足工业物联网领域的海量数据存储、高速数据读取和复杂数据分析需求。Apache IoTDB项目源自清华大学，2020年成长为Apache基金会国际顶级项目，社区来自中、德、美、澳等全球代码贡献者近200人，社区企业用户规模数千人，目前已在国家电网、国家气象局、中航成飞、中核集团、长安汽车、金风科技等企业广泛应用。

欢迎迈出加入 Apache IoTDB 社区的第一步！
QQ群：659990460
微信群：添加好友qinchuqing
github仓库：https://github.com/apache/iotdb
官网：http://iotdb.apache.org/

以下是项目可参与的方向：

1. 我们列出了适合首次加入 Apache IoTDB 社区的贡献者的问题、适合对项目有足够了解的贡献者的特殊 issue 挑战（参见下面的列表）以及一些社区日常任务。如果你愿意解决，请点击该 issue 并在评论区留言“WeOpen Star”（日常及其他任务无需此操作）。提交 PR 时，请同时将 PR 链接到相应的 issue。

2. 对于成功完成任意任务的贡献者，为记录你的积分以及发放奖励，请自行前往你的积分主页记录。积分记录规则详见：关于积分。

在开始贡献之前：

• 请加入【开源摘星计划】社群

  请添加官方小助手微信（微信号：TCOSOO1）

• 建议你通读我们的贡献指南

-apache/iotdb#1995

🌟我们对贡献任务进行了分类，以帮助你找到你感兴趣的任务

社区日常任务

积分奖励：1分/个

• 参与项目例会
• 提交 Issue/Comment

文档类

积分奖励：10分/个

• 官网文档捉虫： http://iotdb.apache.org/ ，在官网上找到任何一个错别字、不通顺句子、表述不清的地方均可。
• 代码仓库ReadMe中英文互备：我们希望iotdb代码仓库中的readme都同时有中文、英文两个版本。欢迎找到各个文件夹中，未做到中英文互备的readme，并协助补充中文或者英文。

编程类

积分奖励：50分/个

• "String#replace" should be preferred to "String#replaceAll" apache/iotdb#7001
• Define a constant instead of duplicating this literal "total" 8 times. apache/iotdb#7013
• Replace the usage of the "instanceof" operator by a catch block. apache/iotdb#7014
• Local variable name 'RawPathToGroupedPathMapInHaving' must match pattern '^[a-z]([a-z0-9][a-zA-Z0-9]*)?$'. apache/iotdb#7015
• Replace this "switch" statement by "if" statements to increase readability. apache/iotdb#7016
• This class overrides "equals()" and should therefore also override "hashCode()". apache/iotdb#5886
• Synchronize this method to match the synchronization on "setModFile". apache/iotdb#5885
• "targetWriter" is a method parameter, and should not be used for synchronization. apache/iotdb#5884
• Cast one of the operands of this addition operation to a "long". apache/iotdb#5883
• Prevent "int" promotion by adding "& 0xff" to this expression. apache/iotdb#5882
• Use try-with-resources or close this "FileOutputStream" in a "finally" clause. apache/iotdb#5881
• Save and re-use this "Random". apache/iotdb#5880
• This class overrides "equals()" and should therefore also override "hashCode()". apache/iotdb#5879
• Use try-with-resources or close this "FileOutputStream" in a "finally" clause. apache/iotdb#5878
• Use try-with-resources or close this "SessionDataSet" in a "finally" clause. apache/iotdb#5877
• Either re-interrupt this method or rethrow the "InterruptedException" that can be caught here. apache/iotdb#5876

其他类

开源知识分享官：提交对本项目的学习笔记或开源相关笔记（视频/文章皆可）并发布在任意社区/博客/视频平台即可申报积分。

积分奖励：10分

额外奖励：每月将为10名优秀笔记作者奖励QQ周边公仔、QQ音乐/腾讯视频年卡及腾源会T恤等好礼。

贡献帮助

有任何反馈或者疑问请联系秦楚晴（微信号：qinchuqing）