You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2020/10/01 11:43:46 UTC
[GitHub] [airflow] Suyog942 opened a new pull request #11221: Update README.md
Suyog942 opened a new pull request #11221:
URL: https://github.com/apache/airflow/pull/11221
Corrected some grammar mistakes.
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines)** for more information.
In case of fundamental code change, Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in [UPDATING.md](https://github.com/apache/airflow/blob/master/UPDATING.md).
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] stale[bot] commented on pull request #11221: Update README.md
Posted by GitBox <gi...@apache.org>.
stale[bot] commented on pull request #11221:
URL: https://github.com/apache/airflow/pull/11221#issuecomment-751246654
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] github-actions[bot] closed pull request #11221: Update README.md
Posted by GitBox <gi...@apache.org>.
github-actions[bot] closed pull request #11221:
URL: https://github.com/apache/airflow/pull/11221
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] jhtimmins commented on a change in pull request #11221: Update README.md
Posted by GitBox <gi...@apache.org>.
jhtimmins commented on a change in pull request #11221:
URL: https://github.com/apache/airflow/pull/11221#discussion_r498473040
##########
File path: README.md
##########
@@ -55,7 +49,7 @@ Use Airflow to author workflows as directed acyclic graphs (DAGs) of tasks. The
- [Airflow merchandise](#airflow-merchandise)
- [Links](#links)
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+<!-- END doctoc generated TOC please keep comment here to allow auto-update -->
Review comment:
The inclusion of a dash (`-`) here is causing a test to fail, as this text is auto-generated.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] jhtimmins commented on a change in pull request #11221: Update README.md
Posted by GitBox <gi...@apache.org>.
jhtimmins commented on a change in pull request #11221:
URL: https://github.com/apache/airflow/pull/11221#discussion_r498472638
##########
File path: README.md
##########
@@ -1,20 +1,14 @@
<!--
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
+ Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file
Review comment:
Airflow has identical license info at the top of every file, and that should stay consistent. Can you revert the newlines and line length back to the original format?
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] boring-cyborg[bot] commented on pull request #11221: Update README.md
Posted by GitBox <gi...@apache.org>.
boring-cyborg[bot] commented on pull request #11221:
URL: https://github.com/apache/airflow/pull/11221#issuecomment-702077899
Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst)
Here are some useful points:
- Pay attention to the quality of your code (flake8, pylint and type annotations). Our [pre-commits]( https://github.com/apache/airflow/blob/master/STATIC_CODE_CHECKS.rst#prerequisites-for-pre-commit-hooks) will help you with that.
- In case of a new feature add useful documentation (in docstrings or in `docs/` directory). Adding a new operator? Check this short [guide](https://github.com/apache/airflow/blob/master/docs/howto/custom-operator.rst) Consider adding an example DAG that shows how users should use it.
- Consider using [Breeze environment](https://github.com/apache/airflow/blob/master/BREEZE.rst) for testing locally, itโs a heavy docker but it ships with a working Airflow and a lot of integrations.
- Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
- Please follow [ASF Code of Conduct](https://www.apache.org/foundation/policies/conduct) for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
- Be sure to read the [Airflow Coding style]( https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#coding-style-and-best-practices).
Apache Airflow is a community-driven project and together we are making it better ๐.
In case of doubts contact the developers at:
Mailing List: dev@airflow.apache.org
Slack: https://s.apache.org/airflow-slack
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] jhtimmins commented on a change in pull request #11221: Update README.md
Posted by GitBox <gi...@apache.org>.
jhtimmins commented on a change in pull request #11221:
URL: https://github.com/apache/airflow/pull/11221#discussion_r498465374
##########
File path: README.md
##########
@@ -79,22 +73,22 @@ Apache Airflow is tested with:
Visit the official Airflow website documentation (latest **stable** release) for help with [installing Airflow](https://airflow.apache.org/installation.html), [getting started](https://airflow.apache.org/start.html), or walking through a more complete [tutorial](https://airflow.apache.org/tutorial.html).
-> Note: If you're looking for documentation for master branch (latest development branch): you can find it on [ReadTheDocs](https://airflow.readthedocs.io/en/latest/).
+> Note: If you're looking for documentation for the master branch (latest development branch): you can find it on [ReadTheDocs](https://airflow.readthedocs.io/en/latest/).
For more information on Airflow's Roadmap or Airflow Improvement Proposals (AIPs), visit the [Airflow Wiki](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Home).
Official Docker (container) images for Apache Airflow are described in [IMAGES.rst](IMAGES.rst).
## Installing from PyPI
-We publish Apache Airflow as `apache-airflow` package in PyPI. Installing it however might be sometimes tricky
Review comment:
`an` isn't the correct article in this case, since `apache-airflow` is the name of the specific package, and does not refer to a general type or group of packages.
##########
File path: README.md
##########
@@ -128,20 +122,20 @@ and our official source code releases:
[Release Approval Process](http://www.apache.org/legal/release-policy.html#release-approval)
Following the ASF rules, the source packages released must be sufficient for a user to build and test the
-release provided they have access to the appropriate platform and tools.
+the release provided they have access to the appropriate platform and tools.
Review comment:
`the` is duplicated
##########
File path: README.md
##########
@@ -128,20 +122,20 @@ and our official source code releases:
[Release Approval Process](http://www.apache.org/legal/release-policy.html#release-approval)
Following the ASF rules, the source packages released must be sufficient for a user to build and test the
-release provided they have access to the appropriate platform and tools.
+the release provided they have access to the appropriate platform and tools.
## Convenience packages
There are other ways of installing and using Airflow. Those are "convenience" methods - they are
not "official releases" as stated by the `ASF Release Policy`, but they can be used by the users
-who do not want to build the software themselves.
Review comment:
`do` is correct in this case since `users` is plural.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org