Contribute to Doris
Contribute to Doris
Thank you very much for your interest in the Doris project. We welcome your suggestions, comments (including criticisms) and contributions to the Doris project.
Your suggestions, comments and contributions on Doris can be made directly through GitHub's Issues.
There are many ways to participate in and contribute to Doris projects: code implementation, test writing, process tool improvement, document improvement, and so on. Any contribution will be welcomed and you will be added to the list of contributors. Further, with sufficient contributions, you will have the opportunity to become a Committer of Apache with Apache mailbox and be included in the list of Apache Committers.
Any questions, you can contact us to get timely answers, including Wechat, Gitter (GitHub instant messaging tool), e-mail and so on.
Initial contactβ
For the first time in Doris community, you can:
Follow Doris Github
Subscribe to our mailing list;
Join Doris Wechat Group (add WeChat-ID: morningman-cmy, note: join Doris Group) and ask questions at any time.
Enter Doris's Slack
Learn the development trends of Doris project in time and give your opinions on the topics you are concerned about.
Doris's code and documentationβ
As you can see from GitHub, Apache Doris (incubating) code base mainly consists of three parts: Frontend (FE), Backend (BE) and Broker (to support file reading on external storage systems such as HDFS). Documents are mainly the wiki on Doris website and GitHub, as well as the online help manual when running Doris. Details of these components can be found in the following table:
| Component Name | Component Description | Related Language |
|---|---|---|
| Frontend daemon (FE) | consists of a query coordinator and a metadata manager | Java |
| Backend daemon (BE) | Responsible for storing data and executing query fragments | C++ |
| Broker | Read HDFS data to Doris | Java |
| Website | Doris Website | Markdown |
| Manager | Doris Manager | Java |
| Flink-Connector | Doris Flink Connector | Java |
| Spark-Connector | Doris Spark Connector | Java |
| Doris Runtime Help Document | Online Help Manual at Doris Runtime | Markdown |
Improving documentationβ
Documentation is the most important way for you to understand Apache Doris, and it's where we need help most!
Browsing the document, you can deepen your understanding of Doris,and can also help you understand Doris's function and technical details. If you find that the document has problems, please contact us anytime;
If you are interested in improving the quality of documents, whether it is revising the address of a page, correcting a link, and writing a better introductory document, we are very welcome!
Most of our documents are written in markdown format, and you can modify and submit document changes directly through apache/doris-website .
If you are committing a document change, you can refer to the Docs Contribute
If you submit code changes, you can refer to Pull Request.
If a Bug or problem is foundβ
If a Bug or problem is found, you can directly raise a new Issue through GitHub's Issues, and we will have someone deal with it regularly.
You can also fix it yourself by reading the analysis code (of course, it's better to talk to us before that, maybe someone has fixed the same problem) and submit a Pull Request.
Modify the code and submit PR (Pull Request)β
You can download the code, compile and install it, deploy and run it for a try (refer to the compilation document) to see if it works as you expected. If you have problems, you can contact us directly, ask questions or fix them by reading and analyzing the source code.
Whether it's fixing Bugs or adding Features, we're all very welcome. If you want to submit code to Doris, you need to create a new branch for your submitted code from the fork code library on GitHub to your project space, add the source project upstream, and submit PR.
About how to submit a PR refer to Pull Request.
