| <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Apache Dubbo – Contributor Guide</title><link>https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/</link><description>Recent content in Contributor Guide on Apache Dubbo</description><generator>Hugo -- gohugo.io</generator><language>en</language><atom:link href="https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/index.xml" rel="self" type="application/rss+xml"/><item><title>Docs: How to become a Dubbo committer</title><link>https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/become-a-committer_dev/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/become-a-committer_dev/</guid><description> |
| <p>Anyone can be a contributor to an Apache project. Being a contributor simply means that you take an interest in the project and contribute in some way, ranging from asking sensible questions (which documents the project and provides feedback to developers) through to providing new features as patches.</p> |
| <p>If you become a valuable contributor to the project you may well be invited to become a committer. Committer is a term used at the ASF to signify someone who is committed to a particular project. It brings with it the privilege of write access to the project repository and resources.</p> |
| <p>In Dubbo community, if a committer who have earned even more merit, can be invited to be a part of the Project Management Committee (PMC).</p> |
| <p>One thing that is sometimes hard to understand when you are new to the open development process used at the ASF, is that we value the community more than the code. A strong and healthy community will be respectful and be a fun and rewarding place. More importantly, a diverse and healthy community can continue to support the code over the longer term, even as individual companies come and go from the field.</p> |
| <p>More details could be found <a href="https://community.apache.org/contributors/">here</a>.</p> |
| <h3 id="what-can-i-contribute">What can I contribute?</h3> |
| <p>Please refer to the <a href="https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/new-contributor-guide_dev">new contributor guide</a>.</p></description></item><item><title>Docs: CLA Signing Guide</title><link>https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/cla-signing-guide_dev/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/cla-signing-guide_dev/</guid><description> |
| <p>You are required to sign the Apache ICLA under the following condition:</p> |
| <ul> |
| <li>You have made lots of contribution to Dubbo before Dubbo get donated to Apache, and you haven&rsquo;t sign the Alibaba-CLA before.</li> |
| <li>You have made lots of contribution to Dubbo, and you are invited to become committer of Dubbo, and you have not signed Alibaba-CLA or Apache ICLA before.</li> |
| </ul> |
| <h4 id="steps">Steps</h4> |
| <ul> |
| <li>Download this <a href="https://www.apache.org/licenses/icla.pdf">pdf</a></li> |
| <li>Fill in the necessary blanks</li> |
| <li>Print it out</li> |
| <li>Sign the printed file</li> |
| <li>Scan it</li> |
| <li>Send an email to <a href="mailto:secretary@apache.org">secretary@apache.org</a> and cc <a href="mailto:private@dubbo.apache.org">private@dubbo.apache.org</a>: |
| <ul> |
| <li>entitled with &ldquo;ICLA submission&rdquo;</li> |
| <li>please also provide the link to your github account in the email body</li> |
| <li>remember to add you ICLA as attachment.</li> |
| </ul> |
| </li> |
| </ul> |
| <h4 id="explanation-to-the-fields">Explanation to the fields</h4> |
| <ul> |
| <li>Mailing address: Your company address in English is preferred.</li> |
| <li>preferred apache id(s): if you are invited to become committers, you have to choose one apache id, otherwise you can leave it blank.</li> |
| <li>notify project: Dubbo (This means Dubbo is the project who notifies you to sign the ICLA)</li> |
| </ul></description></item><item><title>Docs: New Contributor Guide</title><link>https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/new-contributor-guide_dev/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/new-contributor-guide_dev/</guid><description> |
| <p>This is a guide for new comers who wants to contribute to Dubbo.</p> |
| <h3 id="subscribe-to-the-mailing-list">Subscribe to the mailing list</h3> |
| <p>The mailing list is the recommended way for discussing almost anything that related to Dubbo. Please refer to this <a href="https://github.com/apache/dubbo/issues/1393">issue</a> for detailed documentation on how to subscribe.</p> |
| <p>To subscribe to the following mailing list, please refer to <a href="https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/mailing-list-subscription-guide_dev">Mailing list subscription guide</a></p> |
| <ul> |
| <li><a href="mailto:dev@dubbo.apache.org">dev@dubbo.apache.org</a>: the develop mailing list, you can ask question here if you have encountered any problem when using or developing Dubbo.</li> |
| <li><a href="mailto:commits@dubbo.apache.org">commits@dubbo.apache.org</a>: all the commits will be sent to this mailing list. You can subscribe to it if you are interested in Dubbo&rsquo;s development.</li> |
| <li><a href="mailto:issues@dubbo.apache.org">issues@dubbo.apache.org</a>: all the JIRA <a href="https://issues.apache.org/jira/projects/DUBBO/issues">issues</a> 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.</li> |
| </ul> |
| <h3 id="reporting-issue">Reporting issue</h3> |
| <p>You can always reporting an issue to Dubbo via Github <a href="https://github.com/apache/dubbo/issues">Issues</a>.</p> |
| <p>If you are reporting bugs, please refer to the issue report <a href="https://github.com/apache/dubbo/issues/new?template=dubbo-issue-report-template.md">template</a>.</p> |
| <p>If you are reporting regualur issues, like raise an question, you can open an <a href="https://github.com/apache/dubbo/issues/new">regular issue</a></p> |
| <h3 id="sending-pull-request">Sending pull request</h3> |
| <ul> |
| <li>Follow the checklist in the <a href="https://github.com/apache/dubbo/blob/master/PULL_REQUEST_TEMPLATE.md">pull request template</a></li> |
| <li>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:</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>git remote add upstream git@github.com:apache/dubbo.git |
| </span></span><span style="display:flex;"><span>git fetch upstream |
| </span></span><span style="display:flex;"><span>git rebase upstream/master |
| </span></span><span style="display:flex;"><span>git checkout -b your_awesome_patch |
| </span></span><span style="display:flex;"><span>... add some work |
| </span></span><span style="display:flex;"><span>git push origin your_awesome_patch |
| </span></span></code></pre></div><h3 id="code-convention">Code convention</h3> |
| <p>Please check the <a href="https://github.com/apache/dubbo/blob/master/CONTRIBUTING.md">CONTRIBUTING.md</a> for code convention.</p> |
| <h3 id="participate-in-the-release-vote">Participate in the release vote</h3> |
| <p>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 <a href="https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist">check list</a>. |
| If you have any question regarding the check list, please feel free to ask on <a href="mailto:dev@dubbo.apache.org">dev@dubbo.apache.org</a>.</p> |
| <h3 id="what-can-i-contribute">What can I contribute?</h3> |
| <ul> |
| <li>Take a look at issues with tag called <a href="https://github.com/apache/dubbo/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22"><code>Good first issue</code></a> or <a href="https://github.com/apache/dubbo/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22"><code>Help wanted</code></a>.</li> |
| <li>Join the discussion on mailing list, subscription <a href="https://github.com/apache/dubbo/wiki/Mailing-list-subscription-guide">guide</a>.</li> |
| <li>Answer questions on <a href="https://github.com/apache/dubbo/issues">issues</a>.</li> |
| <li>Fix bugs reported on <a href="https://github.com/apache/dubbo/issues">issues</a>, and send us pull request.</li> |
| <li>Review the existing <a href="https://github.com/apache/dubbo/pulls">pull request</a>.</li> |
| <li>Improve the <a href="https://github.com/apache/dubbo-website">website</a>, typically we need |
| <ul> |
| <li>blog post</li> |
| <li>translation on documentation</li> |
| <li>use cases about how Dubbo is being used in enterprise system.</li> |
| </ul> |
| </li> |
| <li>Improve the <a href="https://github.com/apache/dubbo-admin">dubbo-admin/dubbo-monitor</a>.</li> |
| <li>Contribute to the projects listed in <a href="https://github.com/dubbo">ecosystem</a>.</li> |
| <li>Any form of contribution that is not mentioned above.</li> |
| <li>If you would like to contribute, please send an email to <a href="mailto:dev@dubbo.apache.org">dev@dubbo.apache.org</a> to let us know!</li> |
| </ul></description></item><item><title>Docs: Mailing List Subscription Guide</title><link>https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/mailing-list-subscription-guide_dev/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/mailing-list-subscription-guide_dev/</guid><description> |
| <p>The Dubbo developer mailing list (<a href="mailto:dev@dubbo.apache.org">dev@dubbo.apache.org</a>) for Apache Incubator has been established, please feel free to subscribe and refer to [^1] for more details.</p> |
| <p>You can also view <a href="https://lists.apache.org/list.html?dev@dubbo.apache.org">the archive of the mailing list</a></p> |
| <p>Here is a brief guide specific to Dubbo:</p> |
| <ol> |
| <li>Send an email to <a href="mailto:dev-subscribe@dubbo.apache.org">dev-subscribe@dubbo.apache.org</a>, you can have empty subject and empty content. You will receive an email with the following content:</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>from: dev-help@dubbo.apache.org |
| </span></span><span style="display:flex;"><span>reply-to: dev-sc.xxxxxxx.xxxxxxxx-hello=example.com@dubbo.apache.org |
| </span></span><span style="display:flex;"><span>to: hello@example.com |
| </span></span><span style="display:flex;"><span>date: Sat, Feb 24, 2018 at 3:12 PM |
| </span></span><span style="display:flex;"><span>subject: confirm subscribe to dev@dubbo.apache.org |
| </span></span><span style="display:flex;"><span>mailed-by: apache.org |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Hi! This is the ezmlm program. I&#39;m managing the |
| </span></span><span style="display:flex;"><span>dev@dubbo.apache.org mailing list. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>I&#39;m working for my owner, who can be reached |
| </span></span><span style="display:flex;"><span>at dev-owner@dubbo.apache.org. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>To confirm that you would like |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> hello@example.com |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>added to the dev mailing list, please send |
| </span></span><span style="display:flex;"><span>a short reply to this address: |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> dev-sc.xxxxxxx.xxxxxxxx-hello=example.com@dubbo.apache.org |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Usually, this happens when you just hit the &#34;reply&#34; button. |
| </span></span><span style="display:flex;"><span>If this does not work, simply copy the address and paste it into |
| </span></span><span style="display:flex;"><span>the &#34;To:&#34; field of a new message. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>or click here: |
| </span></span><span style="display:flex;"><span> mailto:dev-sc.xxxxxxx.xxxxxxxx-hello=example.com@dubbo.apache.org |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>... |
| </span></span></code></pre></div><ol start="2"> |
| <li>Reply the email directly, you can have empty subject and empty content. You will receive an email with the following content:</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>from: dev-help@dubbo.apache.org |
| </span></span><span style="display:flex;"><span>to: hello@example.com |
| </span></span><span style="display:flex;"><span>date: Sat, Feb 24, 2018 at 3:14 PM |
| </span></span><span style="display:flex;"><span>subject: WELCOME to dev@dubbo.apache.org |
| </span></span><span style="display:flex;"><span>mailed-by: apache.org |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Hi! This is the ezmlm program. I&#39;m managing the |
| </span></span><span style="display:flex;"><span>dev@dubbo.apache.org mailing list. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>I&#39;m working for my owner, who can be reached |
| </span></span><span style="display:flex;"><span>at dev-owner@dubbo.apache.org. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Acknowledgment: I have added the address |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> hello@example.com |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>to the dev mailing list. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Welcome to dev@dubbo.apache.org! |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Please save this message so that you know the address you are |
| </span></span><span style="display:flex;"><span>subscribed under, in case you later want to unsubscribe or change your |
| </span></span><span style="display:flex;"><span>subscription address. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>... |
| </span></span></code></pre></div><ol start="3"> |
| <li> |
| <p>After that, you will receive any email that is posted to this mailing list. If you have any further questions, just send email to <a href="mailto:dev@dubbo.apache.org">dev@dubbo.apache.org</a> and hopefully someone will answer your questions.</p> |
| </li> |
| <li> |
| <p>If you want to unsubscribe, just send an email to <a href="mailto:dev-unsubscribe@dubbo.apache.org">dev-unsubscribe@dubbo.apache.org</a>, and follow the steps once you get an reply.</p> |
| </li> |
| </ol> |
| <blockquote> |
| <p>Note that <a href="mailto:dev@dubbo.apache.org">dev@dubbo.apache.org</a> is valid. <a href="mailto:dev@dubbo.incubator.apache.org">dev@dubbo.incubator.apache.org</a> is no longer applicable.</p> |
| </blockquote> |
| <p>[^1] <a href="http://apache.org/foundation/mailinglists.html#subscribing">http://apache.org/foundation/mailinglists.html#subscribing</a></p></description></item><item><title>Docs: Software Donation Guide</title><link>https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/software-donation-guide_dev/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/software-donation-guide_dev/</guid><description> |
| <p>Before you go through this guide, make sure you have confirmed with PMC that a SGA is actually needed.</p> |
| <p>If you are donating significant amount of code or documentation to Apache Dubbo , you will be required to sign a <a href="https://www.apache.org/licenses/#grants">Software Grant</a> before your code/doc could be merged.</p> |
| <h4 id="steps">Steps</h4> |
| <ol> |
| <li>Download this <a href="https://www.apache.org/licenses/software-grant-template.pdf">pdf</a></li> |
| <li>Print it out</li> |
| <li>Fill in the blanks (see below as an example)</li> |
| <li>Request your boss to sign it</li> |
| <li>Scan it</li> |
| <li>Send an email to <a href="mailto:secretary@apache.org">secretary@apache.org</a> and cc <a href="mailto:private@dubbo.apache.org">private@dubbo.apache.org</a></li> |
| </ol> |
| <h4 id="example">Example:</h4> |
| <p>Below is an text versioned <strong>example</strong>, original text could be found <a href="https://www.apache.org/licenses/software-grant.txt">here</a></p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>License Agreement |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> This License Agreement is entered into as of the _12th_ day of |
| </span></span><span style="display:flex;"><span>___April____, __2018__ by ___ABC Software Co., Ltd.____ (&#34;Licensor&#34;), |
| </span></span><span style="display:flex;"><span>in favor of The Apache Software Foundation, a Delaware nonstock |
| </span></span><span style="display:flex;"><span>membership corporation (the &#34;Foundation&#34;). |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> WHEREAS, Licensor owns or has sufficient rights to contribute the |
| </span></span><span style="display:flex;"><span>software source code and other related intellectual property as |
| </span></span><span style="display:flex;"><span>itemized on Exhibit A (&#34;Software&#34;) under the terms of this agreement |
| </span></span><span style="display:flex;"><span>to the Foundation for use within Foundation software development |
| </span></span><span style="display:flex;"><span>projects (&#34;Projects&#34;). |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> NOW, THEREFORE, FOR GOOD AND VALUABLE CONSIDERATION, the receipt |
| </span></span><span style="display:flex;"><span>and legal sufficiency of which are hereby acknowledged, the parties |
| </span></span><span style="display:flex;"><span>hereto, intending to be legally bound, agree as follows: |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>1. Subject to the terms and conditions of this License, Licensor |
| </span></span><span style="display:flex;"><span>hereby grants to the Foundation: |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> a) a non-exclusive, worldwide, royalty-free, irrevocable |
| </span></span><span style="display:flex;"><span> copyright license to reproduce, prepare derivative works of, |
| </span></span><span style="display:flex;"><span> publicly display, publicly perform, distribute and sublicense, |
| </span></span><span style="display:flex;"><span> internally and externally, the Software and such derivative |
| </span></span><span style="display:flex;"><span> works, in source code and object code form; and, |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> b) a non-exclusive, worldwide, royalty-free, irrevocable |
| </span></span><span style="display:flex;"><span> patent license under Licensed Patents to make, use, sell, |
| </span></span><span style="display:flex;"><span> offer to sell, import and otherwise transfer the Software |
| </span></span><span style="display:flex;"><span> in source code and object code form. &#34;Licensed Patents&#34; mean |
| </span></span><span style="display:flex;"><span> patent claims owned by Licensor which are necessarily |
| </span></span><span style="display:flex;"><span> infringed by the use or sale of the Software alone. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>2. Licensor represents that, to Licensor&#39;s knowledge, Licensor is |
| </span></span><span style="display:flex;"><span>legally entitled to grant the above license. Licensor agrees to notify |
| </span></span><span style="display:flex;"><span>the Foundation of any facts or circumstances of which Licensor becomes |
| </span></span><span style="display:flex;"><span>aware and which makes or would make Licensor&#39;s representations in this |
| </span></span><span style="display:flex;"><span>License Agreement inaccurate in any respect. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>3. This Software is provided AS-IS, WITHOUT WARRANTIES OR CONDITIONS |
| </span></span><span style="display:flex;"><span>OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, |
| </span></span><span style="display:flex;"><span>ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY |
| </span></span><span style="display:flex;"><span>OR FITNESS FOR A PARTICULAR PURPOSE. NEITHER THE LICENSOR NOR ITS |
| </span></span><span style="display:flex;"><span>SUPPLIERS WILL BE LIABLE TO THE FOUNDATION OR ITS LICENSEES FOR ANY |
| </span></span><span style="display:flex;"><span>DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| </span></span><span style="display:flex;"><span>DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED |
| </span></span><span style="display:flex;"><span>AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| </span></span><span style="display:flex;"><span>OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF |
| </span></span><span style="display:flex;"><span>THE USE OR DISTRIBUTION OF THE WORK OR THE EXERCISE OF ANY RIGHTS |
| </span></span><span style="display:flex;"><span>GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>This License Agreement is the entire agreement of the parties |
| </span></span><span style="display:flex;"><span>with respect to its subject matter, and may only be amended by a |
| </span></span><span style="display:flex;"><span>writing signed by each party. This License Agreement may be |
| </span></span><span style="display:flex;"><span>executed in one or more counterparts, each of which shall be |
| </span></span><span style="display:flex;"><span>considered an original. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> IN WITNESS WHEREOF, Licensor has executed this License Agreement |
| </span></span><span style="display:flex;"><span>as of the date first written above. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> LICENSOR: |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> Signed By: _____________________________________ &lt;--- Your boss&#39;s sign here |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> Print Name: _____Lei Li_________________________ &lt;--- Your boss&#39;s name here |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> Title: ____Director_____________________________ &lt;--- Your boss&#39;s title here |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> Representing: ____ABC Software Co., Ltd. _______ |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> ________________________________________________ |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> Contact Name: ____Lei Li________________________ &lt;--- Your boss&#39;s name here |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> Contact Email: ____lilei@abc.com________________ &lt;--- Your boss&#39;s email here |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Exhibit A |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>List of software and other intellectual property covered by this agreement: |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>* Github address where your code is hosted |
| </span></span><span style="display:flex;"><span>* Pull request link |
| </span></span></code></pre></div></description></item><item><title>Docs: Reporting Security Issues</title><link>https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/reporting-security-issues_dev/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/reporting-security-issues_dev/</guid><description> |
| <p>The Apache Software Foundation takes a rigorous standpoint in annihilating the security issues in its software projects. Apache Dubbo is highly sensitive and forthcoming to issues pertaining to its features and functionality.</p> |
| <h2 id="reporting-vulnerability">REPORTING VULNERABILITY</h2> |
| <p>If you have apprehensions regarding Dubbo&rsquo;s security or you discover vulnerability or potential threat, don’t hesitate to get in touch with the Apache Dubbo Security Team by dropping a mail at <a href="mailto:security@dubbo.apache.org">security@dubbo.apache.org</a>. In the mail, specify the description of the issue or potential threat. You are also urged to recommend the way to reproduce and replicate the issue. The Dubbo community will get back to you after assessing and analysing the findings.</p> |
| <p>PLEASE PAY ATTENTION to report the security issue on the security email before disclosing it on public domain.</p> |
| <h2 id="vulnerability-handling">VULNERABILITY HANDLING</h2> |
| <p>An overview of the vulnerability handling process is:</p> |
| <ul> |
| <li>The reporter reports the vulnerability privately to Apache.</li> |
| <li>The appropriate project&rsquo;s security team works privately with the reporter to resolve the vulnerability.</li> |
| <li>A new release of the Apache product concerned is made that includes the fix.</li> |
| <li>The vulnerability is publically announced.</li> |
| </ul> |
| <p>A more detailed description of the process can be found <a href="https://www.apache.org/security/committers.html">here</a></p></description></item><item><title>Docs: Extension Guide</title><link>https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/dubbo-extension-guide_dev/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/dubbo-extension-guide_dev/</guid><description> |
| <p>Dubbo Use microkernel + plugin design pattern. Microkernel is only responsible for assembling plugins, the functions of Dubbo are implemented by extension points(plugins), which means that all functions of Dubbo can be replaced by user customized extension.</p> |
| <h2 id="dubbo-ecosystem">Dubbo Ecosystem</h2> |
| <p>We recommend you to put extension to Dubbo <a href="https://github.com/dubbo">ecosystem</a>. Using this pattern will keep the core repository cleaner and decrease the maintains work. With less code also speed up core repository build process.</p> |
| <h2 id="dependency">Dependency</h2> |
| <p>Implement your own Dubbo extension, in general is just dependence on API jar correspond to what you want. |
| For example:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo-serialization-api<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>${dubbo.version}<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span></code></pre></div><h2 id="src-guide">Src Guide</h2> |
| <p>Usually, implement special extension, just need reference the <a href="https://dubbo.apache.org/en/latest/contribution-guidelines/">Developer Guide</a> docs. Implement necessary interface and adapt extension to dubbo. Besides, some others should be considered:</p> |
| <ol> |
| <li>Well tested. You should write unit test and mock test to eliminate potential bugs.</li> |
| <li>No warning, if some warning cannot to avoid, use @SuppressWarnings to suppress it, but do not abuse it.</li> |
| <li>README. Add necessary readme to show how to use your extension, and something to take notice.</li> |
| <li>License. Make sure of use Apache License 2.0.</li> |
| </ol> |
| <h2 id="notify-the-community">Notify the Community</h2> |
| <ol> |
| <li>Commit your code to <a href="https://github.com">GitHub</a>.</li> |
| <li>Join the mail list (recommended). <a href="https://github.com/apache/dubbo/wiki/Mailing-list-subscription-guide">HowTo</a></li> |
| <li>Send email to <a href="mailto:dev@incubator.dubbo.apache.org">dev@incubator.dubbo.apache.org</a> to notify the community</li> |
| <li>Usually, after sending email, community will discuss your extension, and Administrators of dubbo group will contact you for transfer project to dubbo ecosystem.</li> |
| </ol> |
| <h2 id="transfer-project-to-dubbo-group">Transfer Project to Dubbo Group</h2> |
| <ol> |
| <li>Administrators of dubbo group will ask you, grant your project owner to dubbo.</li> |
| <li>Administrators of dubbo group will create a new project under dubbo group and invite you join the project.</li> |
| <li>Once you accept the invitation, you can transfer your project to new project under dubbo group.</li> |
| <li>Existing members of dubbo group will do the code review. After that you may make some improvement to code.</li> |
| </ol></description></item><item><title>Docs: Test Coverage Guide</title><link>https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/test-coverage-guide_dev/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/test-coverage-guide_dev/</guid><description> |
| <h3 id="the-benefits-of-unit-testing">The benefits of unit testing</h3> |
| <ul> |
| <li>Unit test code can help everyone to go into details and understand the function of the code.</li> |
| <li>We can find bugs by test case, and then enhance the robustness of the code.</li> |
| <li>Test case code is also the demo usage of the core code.</li> |
| </ul> |
| <h3 id="some-design-principle-of-unit-test-case">Some design principle of unit test case</h3> |
| <ul> |
| <li>Steps, fine-grained and combination conditions should be well designed.</li> |
| <li>Attention to boundary condition test</li> |
| <li>Test code should also be designed without writing useless code.</li> |
| <li>When you find a <code>method</code> that is hard to write unit test, if you can be sure the <code>method</code> is &ldquo;smelly code&rdquo;, then refactor it with the committer.</li> |
| <li>The mock framework in dubbo is: <a href="http://site.mockito.org/">mockito</a>. Some tutorials:<a href="https://www.baeldung.com/bdd-mockito">mockito tutorial</a>,<a href="https://dzone.com/refcardz/mockito">mockito refcard</a></li> |
| <li>TDD（optional）：When you start a new issue, you can try to write test case at first</li> |
| </ul> |
| <h3 id="the-specified-value-of-the-test-coverage">The specified value of the test coverage</h3> |
| <ul> |
| <li>In the stage, the test coverage specified value of delta changed codes is ：&gt;=60%. The higher, the better.</li> |
| <li>We can see the coverage report in this page: <a href="https://codecov.io/gh/apache/dubbo">https://codecov.io/gh/apache/dubbo</a></li> |
| </ul></description></item></channel></rss> |
