Documentation

New contributor guide

This is a guide for new comers who wants to contribute to Dubbo.

Subscribe to the mailing list

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

  • dev@dubbo.apache.org: the develop mailing list, you can ask question here if you have encountered any problem when using or developing Dubbo.
  • commits@dubbo.apache.org: all the commits will be sent to this mailing list. You can subscribe to it if you are interested in Dubbo's development.
  • issues@dubbo.apache.org: all the JIRA issues and updates will be sent to this mailing list. The Dubbo community has decided to use github issues rather than JIRA issues, therefore it is expected that most of the issues will be tracked by github issues. The JIRA issues are used to track ASF related issues.

Reporting issue

You can always reporting an issue to Dubbo via Github Issues.

If you are reporting bugs, please refer to the issue report template.

If you are reporting regualur issues, like raise an question, you can open an regular issue

Sending pull request

  • 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

Code convention

Please check the CONTRIBUTING.md for code convention.

Participate in the release vote

Participate in the release vote is an important way to contribute to Dubbo. The Dubbo community welcomes everyone to partipate, you can check the release vote using this check list. If you have any question regarding the check list, please feel free to ask on dev@dubbo.apache.org.

What can I contribute?

  • Take a look at issues with tag called Good first issue or Help wanted.
  • Join the discussion on mailing list, subscription guide.
  • Answer questions on issues.
  • Fix bugs reported on issues, and send us pull request.
  • Review the existing pull request.
  • Improve the website, typically we need
    • blog post
    • translation on documentation
    • use cases about how Dubbo is being used in enterprise system.
  • Improve the dubbo-admin/dubbo-monitor.
  • Contribute to the projects listed in ecosystem.
  • Any form of contribution that is not mentioned above.
  • If you would like to contribute, please send an email to dev@dubbo.apache.org to let us know!