Skip to content

Commit

Permalink
[Improve](docs)new libraries check (apache#18634)
Browse files Browse the repository at this point in the history
  • Loading branch information
CalvinKirs authored Apr 13, 2023
1 parent 40a3529 commit 05badac
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
10 changes: 9 additions & 1 deletion docs/en/community/how-to-contribute/contributor-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,5 +88,13 @@ and you will be able to manage issues and pull request directly through our Gith

11. Select "squash and merge" to merge.

12. When there is a disagreement about a modification, try to discuss the resolution. If the discussion doesn't work out, it can be resolved by a vote in private@doris.apache.org by the majority rules.
12. When there is a disagreement about a modification, try to discuss the resolution. If the discussion doesn't work out, it can be resolved by a vote in dev@doris.apache.org by the majority rules.

13. Adding External libraries

Extra care should be taken when introducing external libraries. When adding a new library, the following factors should be considered:
- What functionality does the new external library provide? Can the existing libraries provide this functionality (perhaps with some effort)?
- Is the external library maintained by an active contributor community?
- What are the licensing terms of the new library?
- Are you adding the library to a core module? This will affect other parts of the Doris codebase. For example, in Java, if the new library introduces a large number of transitive dependencies, we may encounter unexpected class conflicts, which are difficult to discover through testing because they depend on the order in which libraries are loaded at runtime.

12 changes: 11 additions & 1 deletion docs/zh-CN/community/how-to-contribute/contributor-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,5 +90,15 @@ Moderator主要负责给PR设定相关标签,推动相关reviewer进行评论

11. 代码合入选择“squash and merge”方式进行合入。

12. 对于一个修改不同的reviewer有争议时,可以尝试讨论解决。如果讨论没有办法解决,可以在private@doris中发邮件投票解决,采取少数服从多数的原则。
12. 对于一个修改不同的reviewer有争议时,可以尝试讨论解决。如果讨论没有办法解决,可以在 dev@doris.apache.org 中发邮件投票解决,采取少数服从多数的原则。

13. 新增外部依赖

在引入外部依赖项时要格外谨慎。当需要引入新库时,我们需要考虑以下因素。

- 新增的外部库提供了什么功能? 现有的库能否提供此功能(可能需要一些努力)?
- 外部库是否由活跃的贡献者社区维护?
- 新增库的许可条款是什么。
- 你是否将库添加到基础模块? 这将影响 Doris 代码库的其他部分。以 Java 为例,如果新库引入了大量传递依赖项,那么我们可能会遇到类冲突的意外问题,
这些问题很难通过测试发现,因为这取决于运行时加载库的顺序。

0 comments on commit 05badac

Please sign in to comment.