Skip to content

Commit

Permalink
address review feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
Alan Myrvold committed Oct 29, 2018
1 parent da2980f commit 9f36a1c
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 26 deletions.
13 changes: 1 addition & 12 deletions website/src/_includes/section-menu/contribute.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,7 @@

<li><span class="section-nav-list-main-title">Contribute</span></li>
<li><a href="{{ site.baseurl }}/contribute/">Get started contributing</a></li>
<<<<<<< HEAD
<li><a href="https://cwiki.apache.org/confluence/display/BEAM/Using+IntelliJ+IDE">Using IntelliJ IDE</a></li>
=======
<li><a href="{{ site.baseurl }}/contribute/FAQ">FAQ</a></li>
<li>
<span class="section-nav-list-title">IDE tips</span>

<ul class="section-nav-list">
<li><a href="https://cwiki.apache.org/confluence/display/BEAM/Using+IntelliJ+IDE">Using IntelliJ IDE</a></li>
<li><a href="https://cwiki.apache.org/confluence/display/BEAM/Eclipse+Tips">Eclipse Tips</a></li>
</ul>
</li>
>>>>>>> 8421cb530a... [BEAM-5735] Contributor guide improvements
<li>
<span class="section-nav-list-title">Technical Docs</span>

Expand All @@ -43,6 +31,7 @@
<li>
<span class="section-nav-list-title">Tips</span>
<ul class="section-nav-list">
<li><a href="https://cwiki.apache.org/confluence/display/BEAM/Using+IntelliJ+IDE">Using IntelliJ IDE</a></li>
<li><a href="{{ site.baseurl }}/contribute/java-tips/">Java development tips</a></li>
<li><a href="{{ site.baseurl }}/contribute/python-tips/">Python development tips</a></li>
<li><a href="{{ site.baseurl }}/contribute/go-tips/">Go development tips</a></li>
Expand Down
8 changes: 5 additions & 3 deletions website/src/community/contact-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,14 @@ whichever one seems best!

| How to contact us | When to use it |
| ----------------- | ---------------|
| [user@](https://lists.apache.org/[email protected]) mailing list | User support and questions ([Subscribe](mailto:[email protected]), [Unsubscribe](mailto:[email protected])) |
| [dev@](https://lists.apache.org/[email protected]) mailing list | Development discussions ([Subscribe](mailto:[email protected]), [Unsubscribe](mailto:[email protected])) |
| [commits@](https://lists.apache.org/[email protected]) mailing list | Firehose of commits, bugs, pull requests, etc. ([Subscribe](mailto:[email protected]), [Unsubscribe](mailto:[email protected])) |
| [user@](https://lists.apache.org/[email protected]) mailing list | User support and questions ([Subscribe [email protected]](mailto:[email protected]), [Unsubscribe [email protected]](mailto:[email protected])) |
| [dev@](https://lists.apache.org/[email protected]) mailing list | Development discussions ([Subscribe [email protected]](mailto:[email protected]), [Unsubscribe [email protected]](mailto:[email protected])) |
| [commits@](https://lists.apache.org/[email protected]) mailing list | Firehose of commits, bugs, pull requests, etc. ([Subscribe [email protected]](mailto:[email protected]), [Unsubscribe [email protected]](mailto:[email protected])) |
| [JIRA bug tracker](https://issues.apache.org/jira/browse/BEAM) | Report bugs / discover known issues |
| [StackOverflow](http://stackoverflow.com/questions/tagged/apache-beam) | Ask and answer user support questions |
| [Slack](https://s.apache.org/beam-slack-channel) | Chat with users and developers on channel #beam ([Join](https://s.apache.org/slack-invite)) |
{:.table}

To subscribe or unsubscribe, a blank email is fine.

If you wish to report a security vulnerability, please contact [[email protected]](mailto:[email protected]). Apache Beam follows the typical [Apache vulnerability handling process](https://apache.org/security/committers.html#vulnerability-handling).
8 changes: 3 additions & 5 deletions website/src/contribute/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,13 @@ limitations under the License.

Frequently asked questions about contributing to Apache Beam.

<!-- TODO(BEAM-5737): Move this to confluence wiki
### Who do I ask if I am stuck?
Either email [[email protected]]({{ site.baseurl }}/community/contact-us/) or chat
on [Slack]({{ site.baseurl }}/community/contact-us/).
### How do I join the dev email list?

Send a blank email to [email protected].

### Why can't I assign a jira issue to myself?
Only ASF Jira contributors can be assigned issues. To get the permission to do so, email
Expand Down Expand Up @@ -69,7 +67,7 @@ tagging the reviewer as follows:
R: @reviewer
### Adding yourself as a reviewer
### Opt-in to reviewing pull requests
Find the deepest sub-directory that contains the files you want to be a reviewer
for and add your Github username under `reviewers` in the OWNERS file (create a
Expand Down
2 changes: 1 addition & 1 deletion website/src/contribute/git-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,5 +59,5 @@ For example, to create a pull request:

1. Browse to the URL of your forked repository and propose a pull request.

1. Find a committer to review, and @mention them in the review comments
1. Find a committer to review, and mention the them by adding `R: @username` to the review comments

2 changes: 1 addition & 1 deletion website/src/contribute/gradle-tips.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The mapping of directory to project name is in
To troubleshoot issues:
- the `--info` flag adds verbose logging
- the `--stacktrace` flag adds a stacktrace on failures
- the `--scan` flag creates a web scan page
- the `--scan` flag creates a [Gradle Build Scan](https://guides.gradle.org/creating-build-scans/)

Most re-usable steps are in [BeamModulePlugin.groovy](
https://github.com/apache/beam/blob/master/buildSrc/src/main/groovy/org/apache/beam/gradle/BeamModulePlugin.groovy).
Expand Down
12 changes: 8 additions & 4 deletions website/src/contribute/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,9 @@ To contribute code, you need
[https://s.apache.org/beam-starter-tasks](https://s.apache.org/beam-starter-tasks).
1. Assign the issue to yourself. To get the permission to do so, email
the [dev@ mailing list]({{ site.baseurl }}/community/contact-us)
to introduce yourself and to be added as a contributor in the Beam issue tracker. For example:
to introduce yourself and to be added as a contributor in the Beam issue tracker including your
ASF Jira Username. For example [this welcome email](
https://lists.apache.org/thread.html/e6018c2aaf7dc7895091434295e5b0fafe192b975e3e3761fcf0cda7@%3Cdev.beam.apache.org%3E)

Hi, my name is <your name>. I am interested in contributing <what> to the Apache Beam SDK. I'd like to be added
as a Jira contributor so that I can assign issues to myself. My ASF Jira Username is <username>.
Expand Down Expand Up @@ -153,10 +155,12 @@ as a Jira contributor so that I can assign issues to myself. My ASF Jira Usernam
tests consume shared development resources.
1. Pull requests can only be merged by a
[beam committer]({{ site.baseurl }}/contribute/team/).
To find a committer for your area, look for similar code merges or ask on
[[email protected]]({{ site.baseurl }}/community/contact-us/)
To find a committer for your area, either:
- look in the OWNERS file of the directory where you changed files, or
- an look for similar code merges, or
- ask on [[email protected]]({{ site.baseurl }}/community/contact-us/)

Use @mention in the pull request to notify a reviewer.
Use `R: @username` in the pull request to notify a reviewer.
1. If you don't get any response in 3 business days, email the dev@ list to ask for someone to look at your pull
request.

Expand Down

0 comments on commit 9f36a1c

Please sign in to comment.