[GitHub] [airflow] mschickensoup commented on issue #6511: [AIRFLOW-XXX] Improve the PubSub documentation

[GitBox <gi...@apache.org>]

mschickensoup commented on issue #6511: [AIRFLOW-XXX] Improve the PubSub documentation
URL: https://github.com/apache/airflow/pull/6511#issuecomment-551114631
 
 
   Let me re-phrase the description as well ;-) I've already done them, there's only one question reg. *prepend* in the JIRA section. 
   
   > Make sure you have checked _all_ steps below.
   > 
   > ### Jira
   > * [ ]  My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title e.g.  "[AIRFLOW-XXX] My Airflow PR"
   >   
   >   * https://issues.apache.org/jira/browse/AIRFLOW-XXX
   >   * In case you fix a typo in the documentation you can **prepend** your commit with [AIRFLOW-XXX], code changes always need a Jira issue. || _What did you mean by *prepend* was it supposed to be *pretend*?_
   >   * In case you propose a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
   >   * If you add a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
   > 
   > ### Description
   > * [ ]  Here are some details about my PR including screenshots of some UI changes:
   > 
   > ### Tests
   > * [ ]  My PR adds the following unit tests **OR** does not need testing for this extremely good reason:
   > 
   > ### Commits
   > * [ ]  All of my commits reference to Jira issues in their subject lines. I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)":
   >   
   >   1. Subject is separated from body by a blank line
   >   2. Subject is limited to 50 characters (not including Jira issue reference)
   >   3. Subject does not end with a period
   >   4. Subject uses the imperative mood ("add", not "adding")
   >   5. Body wraps at 72 characters
   >   6. Body explains "what" and "why", not "how"
   > 
   > ### Documentation
   > * [ ]  In case of new functionality, my PR adds documentation that describes how to use it.
   >   
   >   * All the public functions and the classes in the PR contain docstrings that explain what it does
   >   * If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
   
   

----------------------------------------------------------------
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


With regards,
Apache Git Services