Contributor Guide on Apache Dubbo

How to Become a Dubbo Committer

Mon, 01 Jan 0001 00:00:00 +0000

Anyone can become a contributor to an Apache project. Being a contributor simply means you are interested in the project and contribute in some way, from asking reasonable questions (which document the project and provide feedback to the developers) to providing new features as patches.

If you become a valuable contributor to a project, you may be invited to become a Committer. A Committer is a term used by the ASF (Apache Software Foundation) to refer to individuals who commit to a specific project. It grants you write access to the project’s repository and resources.

New Contributor Guide

Mon, 01 Jan 0001 00:00:00 +0000

This guide aims to provide guidance for newcomers preparing to contribute to Dubbo.

Mailing List Description

The mailing list is the official recommended discussion channel for Dubbo, where all topics related to Dubbo can be discussed. Please click Issue for more information about subscribing to the mailing list.

To subscribe to the mailing lists below, please refer to the Mailing List Subscription Guide

dev@dubbo.apache.org: Development mailing list where you can ask any questions encountered while using or developing Dubbo.
commits@dubbo.apache.org: All commit content will be pushed to this mailing list. If you’re interested in Dubbo’s progress, you can subscribe to this mailing list.
issues@dubbo.apache.org: All JIRA Issues and modification information will be pushed to this mailing list. The Dubbo community has decided to use GitHub Issues instead of JIRA Issues, so most Issues will be tracked by GitHub Issues. JIRA Issues are used to track ASF related issues.

Reporting Issues

For non-security issues, raise them directly in GitHub Issues, and also refer to the Issue Template.
For security issues, please refer to “Reporting Vulnerabilities”.

Code Contribution Process

This contribution process applies to all content in the Apache Dubbo community, including but not limited to dubbo (main repository), dubbo-admin, and dubbo-website.

Mailing List Subscription Guide

Mon, 01 Jan 0001 00:00:00 +0000

The Apache Incubator’s Dubbo developer mailing list (dev@dubbo.apache.org) has been established. Please feel free to subscribe and refer to [^1] for more details.

You can also directly view the archive.

Here is a brief guide on subscribing to the Dubbo mailing list:

Send an email to dev-subscribe@dubbo.apache.org, leaving the content and subject empty. You will receive an email with the following content:

from: dev-help@dubbo.apache.org
reply-to: dev-sc.xxxxxxx.xxxxxxxx-hello=example.com@dubbo.apache.org
to: hello@example.com
date: Sat, Feb 24, 2018 at 3:12 PM
subject: confirm subscribe to dev@dubbo.apache.org
mailed-by: apache.org

Hi! This is the ezmlm program. I'm managing the
dev@dubbo.apache.org mailing list.

I'm working for my owner, who can be reached
at dev-owner@dubbo.apache.org.

To confirm that you would like

 hello@example.com

added to the dev mailing list, please send
a short reply to this address:

 dev-sc.xxxxxxx.xxxxxxxx-hello=example.com@dubbo.apache.org

Usually, this happens when you just hit the "reply" button.
If this does not work, simply copy the address and paste it into
the "To:" field of a new message.

or click here:
 mailto:dev-sc.xxxxxxx.xxxxxxxx-hello=example.com@dubbo.apache.org

...

Reply to the email, leaving the content and subject empty, and you will receive another email with the following content:

from: dev-help@dubbo.apache.org
to: hello@example.com
date: Sat, Feb 24, 2018 at 3:14 PM
subject: WELCOME to dev@dubbo.apache.org
mailed-by: apache.org

Hi! This is the ezmlm program. I'm managing the
dev@dubbo.apache.org mailing list.

I'm working for my owner, who can be reached
at dev-owner@dubbo.apache.org.

Acknowledgment: I have added the address

 hello@example.com

to the dev mailing list.

Welcome to dev@dubbo.apache.org!

Please save this message so that you know the address you are
subscribed under, in case you later want to unsubscribe or change your
subscription address.

...

At this point, the mailing list subscription is complete. From now on, you will receive many emails sent to this mailing list. If you have more questions, just send an email to dev@dubbo.apache.org, and someone will answer your questions.

Software Donation Guide

Mon, 01 Jan 0001 00:00:00 +0000

Before you read this guide, please ensure that you have confirmed the actual SGA needed with the PMC.

If you are donating a significant amount of code or documentation to Apache Dubbo, you will need to sign the Software Grant before merging the code or documentation.

Steps to Follow

Download this pdf document
Print the downloaded document
Fill out the form as required (see the example below)
Have your supervisor sign above
Scan the document
Email the scanned document to secretary@apache.org, with a copy to private@dubbo.apache.org

Example

Below is a text example; the original text can be found here

Reporting Security Issues

Mon, 01 Jan 0001 00:00:00 +0000

The Apache Software Foundation takes a strict stance on eliminating security issues in its software projects. Apache Dubbo is very sensitive to issues related to its functionality and features and addresses them promptly.

Reporting Vulnerabilities

If you have concerns about the security of Dubbo, or if you discover vulnerabilities or potential threats, please email the Apache Dubbo security team at security@dubbo.apache.org. In your email, specify a description of the issue or potential threat. You are also encouraged to suggest ways to reproduce and replicate the issue. The Dubbo community will reach out to you after evaluating and analyzing the investigation results.

Extending Dubbo Guide

Mon, 01 Jan 0001 00:00:00 +0000

Dubbo uses a microkernel + plugin design pattern. The kernel is only responsible for assembling plugins, and all of Dubbo’s functionalities are implemented by extension points (plugins), which means that all of Dubbo’s features can be replaced by user-defined extensions.

Dubbo Ecosystem

We recommend adding extensions to the Dubbo ecosystem. Using this model can keep the core repository cleaner and reduce maintenance work. Less code can also improve the build speed of the core repository.

Test Coverage Guide

Mon, 01 Jan 0001 00:00:00 +0000

Benefits of Writing Unit Tests

Unit tests help everyone dive into the details of the code and understand its functionality.
Through test cases, we can discover bugs and enhance the robustness of the code.
Test cases also serve as demo usage of the code.

Some Design Principles for Unit Test Cases

Steps, granularity, and combination conditions should be carefully designed.
Pay attention to boundary conditions.
Unit tests should also be well-designed; do not write useless code.
When you find a method difficult to unit test, if it can be confirmed that this method is smelly code, then refactor it together with the developer.
The mock framework used in Dubbo is: mockito. Below are some developer guides: mockito tutorial, mockito refcard
TDD (optional): When you start writing a new feature, you can try to write the test cases first.

Test Coverage Threshold

At this stage, the test coverage threshold for Delta changes is: >=60%, the higher the better.
We can see the test report on this page: https://codecov.io/gh/apache/dubbo