pcoet commented on code in PR #1: URL: https://github.com/apache/beam-starter-python/pull/1#discussion_r897106461
########## CONTRIBUTING.md: ########## @@ -0,0 +1,69 @@ +# 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 JIRA issue](https://issues.apache.org/jira/secure/CreateIssue!default.jspa). + +## Contributing to this starter project + +If this is your first time contributing to a GitHub repo, +we recommmend going through the +[GitHub quickstart](https://docs.github.com/en/get-started/quickstart/hello-world). + +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](https://docs.github.com/en/get-started/quickstart/fork-a-repo). + +1. Clone the repo. + + ```sh + export GITHUB_USERNAME="my-github-username" + + git clone [email protected]:$GITHUB_USERNAME/beam-starter-python.git + ``` + +1. Set the [upstream remote branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-for-a-fork). + + ```sh + cd beam-starter-python + git remote add upstream [email protected]:apache/beam-starter-python.git + ``` + +1. Create and change to a new branch. + + ```sh + git checkout -B my-branch-name + ``` + +1. Modify the code! 😱 + +1. Run the tests. For steps on how to run them see the [`README.md`](README.md). + +1. Commit and push your changes to your branch in `origin`. + + ```sh + git commit -m "one line description of your changes" + git push + ``` + +1. [Create a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request). + +1. Add reviewers, and [address review comments](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests). + +1. Once it's approved, we can merge the Pull Request. + +For more information about proposing changes to a GitHub repository, see the +[Propose changes](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches) +page in the GitHub docs. + +## Contributing to Apache Beam + +For information on how to contribute to +[Apache Beam](https://github.com/apache/beam), see to the Review Comment: "see to the" -> "see the" ########## README.md: ########## @@ -0,0 +1,78 @@ +# Apache Beam starter for Python + +If you want to clone this repository to start your own project, +you can choose the license you prefer and feel free to delete anything related to the license you are dropping. + +## Before you begin + +Make sure you have a [Python 3](https://www.python.org/) development environment ready. +If you don't, you can follow the instructions in the +[Python 3 Installation & Setup Guide](https://realpython.com/installing-python/). Review Comment: You might consider linking to the official Python docs, instead of RealPython. Or at least use link text that indicates it's RealPython. ########## .github/PULL_REQUEST_TEMPLATE.md: ########## @@ -0,0 +1,12 @@ +**Please** add a meaningful description for your change here + +------------------------ + +Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily: + + - [ ] I agree that my contributions are licensed with both [Apache ASL2](../../LICENSE-APACHE) and [MIT](../../LICENSE-MIT). + - [ ] [**Choose reviewer(s)**](https://beam.apache.org/contribute/#make-your-change) and mention them in a comment (`R: @username`). + - [ ] Format the pull request title like `[BEAM-XXX] Fixes bug in ApproximateQuantiles`, where you replace `BEAM-XXX` with the appropriate JIRA issue, if applicable. This will automatically link the pull request to the issue. Review Comment: +1 to enabling GitHub issues on these. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
