CONTRIBUTING.md

Contributing

🎉🎊 Thanks for taking the time to contribute! 🎉🎊

There are many ways to contribute, here are some.

Filing an issue

If there's any issue you encounter or anything that needs to be fixed, feel free to create a GitHub issue.

Contributing to this starter project

If this is your first time contributing to a GitHub repo, we recommmend going through the GitHub quickstart.

It's a good idea to discuss your plans with the Beam community through the [email protected] mailing list before doing any changes.

Here's a small overview of the process.

1. Fork the repo.

2. Clone the repo.

   export GITHUB_USERNAME="my-github-username"
   
   git clone [email protected]:$GITHUB_USERNAME/beam-starter-python.git

3. Set the upstream remote branch.

   cd beam-starter-python
   git remote add upstream [email protected]:apache/beam-starter-python.git

4. Create and change to a new branch.

   git checkout -B my-branch-name

5. Modify the code! 😱

6. Run the tests. For steps on how to run them see the README.md.

7. Commit and push your changes to your branch in origin.

   git commit -m "one line description of your changes"
   git push

8. Create a Pull Request.

9. Add reviewers, and address review comments.

10. Once it's approved, we can merge the Pull Request.

For more information about proposing changes to a GitHub repository, see the Propose changes page in the GitHub docs.

Contributing to Apache Beam

For information on how to contribute to Apache Beam, see the Contribution guide.