Contribution Guideline

Guidelines for contributing to Dubbo

Dubbo is released under the non-restrictive Apache 2.0 license, and follows a very standard Github development process, using Github tracker for issues and merging pull requests into master. If you want to contribute even something trivial please do not hesitate, but follow the guidelines below.

Sign the Contributor License Agreement

Before we accept a non-trivial patch or pull request we will need you to sign the Contributor License Agreement. Signing the contributor’s agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests.

Contact

Mailing list

The mailing list is the recommended way for discussing almost anything that related to Dubbo. Please refer to this guide for detailed documentation on how to subscribe.

Reporting issue

Please follow the template for reporting any issues.

Code Conventions

Our code style is almost in line with the standard java conventions (Popular IDE’s default setting satisfy this), with the following additional restricts:

  • If there are more than 120 characters in current line, start a new line.

  • Make sure all new .java files to have a simple Javadoc class comment with at least a @date tag identifying birth, and preferably at least a paragraph on what the class is for.

  • Add the ASF license header comment to all new .java files (copy from existing files in the project)

  • Make sure no @author tag added to the file you contribute since @author tag is not used at Apache, other ways such as cvs will record all your contributions fairly.

  • Add some Javadocs and, if you change the namespace, some XSD doc elements.

  • A few unit tests should be added for a new feature or an important bugfix.

  • If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project).

  • When writing a commit message please follow these conventions, if you are fixing an existing issue please add Fixes #XXX at the end of the commit message (where XXX is the issue number).

Contribution flow

This is a rough outline of what a contributor’s workflow looks like:

  • Fork the current repository

  • Create a topic branch from where to base the contribution. This is usually master.

  • Make commits of logical units.

  • Make sure commit messages are in the proper format (see below).

  • Push changes in a topic branch to your forked repository.

  • Follow the checklist in the pull request template

  • Before you sending out the pull request, please sync your forked repository with remote repository, this will make your pull request simple and clear. See guide below:

    git remote add upstream git@github.com:apache/dubbo.git
    git fetch upstream
    git rebase upstream/master
    git checkout -b your_awesome_patch 
    ... add some work
    git push origin your_awesome_patch
    
  • Submit a pull request to apache/dubbo and wait for the reply.

Thanks for contributing!

Code style

We provide a template file dubbo_codestyle_for_idea.xml for IntelliJ idea, you can import it to you IDE. If you use Eclipse you can config manually by referencing the same file.


Contributor Guide

Guidelines for dubbo contributor

Committer Guide

Guidelines for dubbo committer


Last modified November 25, 2020: fix sample code issue for SPI.md (#659) (0576d68)