To propose code changes, you should be familiar with the Git / Github workflow, including:
- forking the github.com/apache/beam repo
- cloning your fork
- syncing your master branch with the upstream apache/beam repository
- squashing commits
- proposing changes in a pull request
Here's a convenient .git/config file that shows how to:
- Set up branches
- Limit fetched branches to master only
- Fetch PRs from upstream
- Configure alias to show a pretty formatted git log.
If you have more simple and useful configs to add, feel free to comment on gist.
How to create a pull request
To create a new pull request, follow the next steps:
- Fork the github.com/apache/beam repo
Clone your fork, for example:
Add an upstream remote for apache/beam to allow syncing changes into your fork:
Create a local branch for your changes:
- Make your code change.
- Add unit tests for your change.
- Ensure tests pass locally.
Commit your change including a reference to the Github issue:
Push your change to your forked repo
Browse to the URL of your forked repository and propose a pull request.
- Find a committer to review, and mention them by adding
R: @usernameto the review comments