This is an automated email from the ASF dual-hosted git repository. mergebot-role pushed a commit to branch asf-site in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit 9193579c22e1f4c01ec3d34fbec026def3280e47 Author: Mergebot <[email protected]> AuthorDate: Wed Apr 25 21:44:16 2018 -0700 Prepare repository for deployment. --- content/contribute/contribution-guide/index.html | 39 ++++++++++++------------ 1 file changed, 19 insertions(+), 20 deletions(-) diff --git a/content/contribute/contribution-guide/index.html b/content/contribute/contribution-guide/index.html index 83653dc..2228bc1 100644 --- a/content/contribute/contribution-guide/index.html +++ b/content/contribute/contribution-guide/index.html @@ -242,7 +242,8 @@ repository</a>.</li> mailing list, which is archived <a href="https://lists.apache.org/[email protected]";>here</a>. Join by emailing -<a href="mailto:[email protected]";><code class="highlighter-rouge">[email protected]</code></a>.</p> +<a href="mailto:[email protected]";><code class="highlighter-rouge">[email protected]</code></a>. +Anyone is welcome to join, and we’d love to hear what you’re interested in.</p> <p>If interested, you can also join the other <a href="/get-started/support/">mailing lists</a>.</p> @@ -250,10 +251,7 @@ emailing <p>We use the Apache Software Foundation’s <a href="https://issues.apache.org/jira/browse/BEAM";>JIRA</a> as an issue tracking and -project management tool, as well as a way to communicate among a very diverse -and distributed set of contributors. To be able to gather feedback, avoid -frustration, and avoid duplicated efforts all Beam-related work should be -tracked there.</p> +project management tool.</p> <p>If you do not already have an Apache JIRA account, sign up <a href="https://issues.apache.org/jira/";>here</a>.</p> @@ -261,20 +259,19 @@ tracked there.</p> <p>If a quick <a href="https://issues.apache.org/jira/issues/?jql=project%3DBEAM%20AND%20text%20~%20%22the%20thing%20I%20want%20to%20contribute%22";>search</a> doesn’t turn up an existing JIRA issue for the work you want to contribute, -create it. Please discuss your idea with a committer or the <a href="https://issues.apache.org/jira/browse/BEAM/?selectedTab=com.atlassian.jira.jira-projects-plugin:components-panel";>component -lead</a> -in JIRA or, alternatively, on the developer mailing list.</p> +feel free to create one.</p> <p>If there’s an existing JIRA issue for your intended contribution, please -comment about your intended work. Once the work is understood, a committer will +comment about your intended work. A committer can assign the issue to you. (If you don’t have a JIRA role yet, you’ll be added to -the “contributor” role.) If an issue is currently assigned, please check with -the current assignee before reassigning.</p> +the “contributor” role.) If an issue is currently assigned, it is generally +good practice to at least reach out the current assignee before reassigning.</p> -<p>For moderate or large contributions, you should not start coding or writing a -design document unless there is a corresponding JIRA issue assigned to you for -that work. Simple changes, like fixing typos, do not require an associated -issue.</p> +<p>For moderate or large contributions, we recommend engaging on the developer +mailing list before investing significant effort to gather feedback, +avoid frustration, and prevent duplicated work. +Simple changes, like fixing typos, do not nead JIRA entries +and are welcome via direct pull requests.</p> <h3 id="online-discussions">Online discussions</h3> @@ -297,10 +294,12 @@ tracking system and/or the dev mailing list.</p> to clearly scope and design non-trivial contributions with the Beam community before you start coding.</p> -<p>Generally, the JIRA issue is the best place to gather relevant design docs, -comments, or references. It’s great to explicitly include relevant stakeholders -early in the conversation. For designs that may be generally interesting, we -also encourage conversations on the developer’s mailing list.</p> +<p>Generally, the developer mailing list is the best place to get help, +solicit feedback, and communicate design docs. +It’s great to explicitly include relevant stakeholders +early in the conversation. JIRA is useful for keeping track of the current +state of implementation and automatically gets updated for actions on pull +requests that start with <code class="highlighter-rouge">[BEAM-JIRA_ID]</code>.</p> <p>We suggest using <a href="https://docs.google.com/";>Google Docs</a> for sharing designs that may benefit from diagrams or comments. Please remember to make the @@ -495,7 +494,7 @@ $ python setup.py sdist <h2 id="review">Review</h2> <p>Once the initial code is complete and the tests pass, it’s time to start the -code review process. We review and discuss all code, no matter who authors it. +code review process. All code is peer reviewed, no matter who authors it. It’s a great way to build community, since you can learn from other developers, and they become familiar with your contribution. It also builds a strong project by encouraging a high quality bar and keeping code consistent -- To stop receiving notification emails like this one, please contact [email protected].
