You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by me...@apache.org on 2018/04/26 04:40:59 UTC
[beam-site] branch mergebot updated (75a17ae -> ef75570)
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a change to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git.
from 75a17ae This closes #428
add 8e8a304 Prepare repository for deployment.
new 5a1d8a0 Update contribution guide to reflect current practices.
new 265088e Further refinement.
new ef75570 This closes #427
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
content/contribute/contribution-guide/index.html | 6 ++--
src/contribute/contribution-guide.md | 37 ++++++++++++------------
2 files changed, 21 insertions(+), 22 deletions(-)
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.
[beam-site] 03/03: This closes #427
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit ef755705e78295b0a4f7d7973a3d11d27200cc21
Merge: 8e8a304 265088e
Author: Mergebot <me...@apache.org>
AuthorDate: Wed Apr 25 21:40:34 2018 -0700
This closes #427
src/contribute/contribution-guide.md | 37 ++++++++++++++++++------------------
1 file changed, 18 insertions(+), 19 deletions(-)
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.
[beam-site] 02/03: Further refinement.
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit 265088ec44da4dceab24c9ce0b6570eda1984488
Author: Robert Bradshaw <ro...@gmail.com>
AuthorDate: Wed Apr 25 09:45:19 2018 -0700
Further refinement.
---
src/contribute/contribution-guide.md | 11 ++++-------
1 file changed, 4 insertions(+), 7 deletions(-)
diff --git a/src/contribute/contribution-guide.md b/src/contribute/contribution-guide.md
index 21cd434..3c16092 100644
--- a/src/contribute/contribution-guide.md
+++ b/src/contribute/contribution-guide.md
@@ -66,6 +66,7 @@ mailing list, which is archived
[here](https://lists.apache.org/list.html?dev@beam.apache.org). Join by
emailing
[`dev-subscribe@beam.apache.org`](mailto:dev-subscribe@beam.apache.org).
+Anyone is welcome to join, and we'd love to hear what you're interested in.
If interested, you can also join the other [mailing lists]({{ site.baseurl
}}/get-started/support/).
@@ -74,9 +75,7 @@ If interested, you can also join the other [mailing lists]({{ site.baseurl
We use the Apache Software Foundation's
[JIRA](https://issues.apache.org/jira/browse/BEAM) 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 avoid duplicated efforts,
-significant Beam-related work should be tracked there.
+project management tool.
If you do not already have an Apache JIRA account, sign up
[here](https://issues.apache.org/jira/).
@@ -84,9 +83,7 @@ If you do not already have an Apache JIRA account, sign up
If a quick
[search](https://issues.apache.org/jira/issues/?jql=project%3DBEAM%20AND%20text%20~%20%22the%20thing%20I%20want%20to%20contribute%22)
doesn’t turn up an existing JIRA issue for the work you want to contribute,
-feel free to create one. Please discuss your idea with a committer or the [component
-lead](https://issues.apache.org/jira/browse/BEAM/?selectedTab=com.atlassian.jira.jira-projects-plugin:components-panel)
-in JIRA or, alternatively, on the developer mailing list.
+feel free to create one.
If there’s an existing JIRA issue for your intended contribution, please
comment about your intended work. A committer can
@@ -303,7 +300,7 @@ $ python setup.py sdist > /dev/null && \
## Review
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
mergebot-role@apache.org.
[beam-site] 01/03: Update contribution guide to reflect current
practices.
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit 5a1d8a00422d84266b27f58812ca77f48849dc6c
Author: Robert Bradshaw <ro...@gmail.com>
AuthorDate: Tue Apr 24 18:18:02 2018 -0700
Update contribution guide to reflect current practices.
Specifically, our use of JIRA vs. the mailing list.
I also tried to be less prescriptive to lower the bar for people just getting started.
---
src/contribute/contribution-guide.md | 32 +++++++++++++++++---------------
1 file changed, 17 insertions(+), 15 deletions(-)
diff --git a/src/contribute/contribution-guide.md b/src/contribute/contribution-guide.md
index 9b614dd..21cd434 100644
--- a/src/contribute/contribution-guide.md
+++ b/src/contribute/contribution-guide.md
@@ -75,9 +75,8 @@ If interested, you can also join the other [mailing lists]({{ site.baseurl
We use the Apache Software Foundation's
[JIRA](https://issues.apache.org/jira/browse/BEAM) 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.
+and distributed set of contributors. To avoid duplicated efforts,
+significant Beam-related work should be tracked there.
If you do not already have an Apache JIRA account, sign up
[here](https://issues.apache.org/jira/).
@@ -85,20 +84,21 @@ If you do not already have an Apache JIRA account, sign up
If a quick
[search](https://issues.apache.org/jira/issues/?jql=project%3DBEAM%20AND%20text%20~%20%22the%20thing%20I%20want%20to%20contribute%22)
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 [component
+feel free to create one. Please discuss your idea with a committer or the [component
lead](https://issues.apache.org/jira/browse/BEAM/?selectedTab=com.atlassian.jira.jira-projects-plugin:components-panel)
in JIRA or, alternatively, on the developer mailing list.
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.
+the “contributor” role.) If an issue is currently assigned, it is generally
+good practice to at least reach out the current assignee before reassigning.
-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.
+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.
### Online discussions
@@ -121,10 +121,12 @@ To avoid potential frustration during the code review cycle, we encourage you
to clearly scope and design non-trivial contributions with the Beam community
before you start coding.
-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.
+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 `[BEAM-JIRA_ID]`.
We suggest using [Google Docs](https://docs.google.com/) for sharing designs
that may benefit from diagrams or comments. Please remember to make the
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.