[
https://issues.apache.org/jira/browse/BEAM-5735?focusedWorklogId=160079&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-160079
]
ASF GitHub Bot logged work on BEAM-5735:
----------------------------------------
Author: ASF GitHub Bot
Created on: 29/Oct/18 17:10
Start Date: 29/Oct/18 17:10
Worklog Time Spent: 10m
Work Description: swegner commented on a change in pull request #6857:
[BEAM-5735] Contributor guide improvements
URL: https://github.com/apache/beam/pull/6857#discussion_r229015660
##########
File path: website/src/contribute/git-workflow.md
##########
@@ -0,0 +1,63 @@
+---
+layout: section
+section_menu: section-menu/contribute.html
+title: "Git workflow"
+permalink: /contribute/git-workflow/
+---
+<!--
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+To propose code changes, you should be familiar with the Git / Github
workflow, including:
+ - [forking](https://help.github.com/articles/fork-a-repo/) the
+ [github.com/apache/beam](https://github.com/apache/beam) repo
+ - [cloning](https://help.github.com/articles/cloning-a-repository/) your
fork
+ - [syncing](https://help.github.com/articles/syncing-a-fork/) your master
branch with the upstream apache/beam
+ repository
+ -
[branching](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/)
+ - [squashing](https://help.github.com/articles/about-git-rebase/) commits
+ - [proposing
changes](https://help.github.com/articles/proposing-changes-to-your-work-with-pull-requests/)
in a pull
+ request
+
+For example, to create a pull request:
+
+1. [Fork](https://help.github.com/articles/fork-a-repo/) the
[github.com/apache/beam](https://github.com/apache/beam) repo
+1. [Clone](https://help.github.com/articles/cloning-a-repository/) your fork,
for example:
+
+ $ git clone [email protected]:${GITHUB_USERNAME}/beam
+ $ cd beam
+
+1. Add an upstream remote for apache/beam to allow syncing changes into your
fork
+
+ $ git remote add upstream https://github.com/apache/beam
+
+1. Create a local branch for your changes
+
+ $ git checkout -b someBranch
+
+1. Make your code change
+1. Add unit tests for your change
+1. Ensure tests pass locally
+1. Commit your change with the name of the jira issue
+
+ $ git add <new files>
+ $ git commit -am "[BEAM-xxxx] Description of change"
+
+1. Push your change to your forked repo
+
+ $ git push --set-upstream origin YOUR_BRANCH_NAME
+
+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
Review comment:
We have differing conventions on how to request a reviewer throughout our
contributor guide. I'd suggest we formalize on the more explicit `R: @mention`;
this will help humans and tools differentiate what you're asking the individual
to do.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 160079)
Time Spent: 1.5h (was: 1h 20m)
> Contributor Guide Improvements
> ------------------------------
>
> Key: BEAM-5735
> URL: https://issues.apache.org/jira/browse/BEAM-5735
> Project: Beam
> Issue Type: Improvement
> Components: website
> Reporter: Scott Wegner
> Assignee: Alan Myrvold
> Priority: Major
> Time Spent: 1.5h
> Remaining Estimate: 0h
>
> This is a wish-list for improvements to the Beam contributor guide.
> Many thanks to [~rohdesam] for the feedback which helped shape this list.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
