You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2019/08/16 21:49:00 UTC

[jira] [Commented] (AIRFLOW-5239) Small typo and incorrect tests in CONTRIBUTING.md

    [ https://issues.apache.org/jira/browse/AIRFLOW-5239?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16909428#comment-16909428 ] 

ASF GitHub Bot commented on AIRFLOW-5239:
-----------------------------------------

coopergillan commented on pull request #5844: [AIRFLOW-5239] Fix listing of pylint test scripts for Docker container
URL: https://github.com/apache/airflow/pull/5844
 
 
   ### Jira
   
   - [x] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW-5239) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
     - https://issues.apache.org/jira/browse/AIRFLOW-5239
   
   ### Description
   
   - [x] Here are some details about my PR, including screenshots of any UI changes:
   
     1. List the two separate `pylint` scripts for use inside the Docker containers in CONTRIBUTING.md, not a single one that appears to no longer exist.
     1. Fix a small typo in another spot of `CONTRIBUTING.md`
   
   ### Tests
   
   - [x] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
     - These are only docs changes
   
   ### Commits
   
   - [x] My commits all reference Jira issues in their subject lines, and 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
     1. Subject is limited to 50 characters (not including Jira issue reference)
     1. Subject does not end with a period
     1. Subject uses the imperative mood ("add", not "adding")
     1. Body wraps at 72 characters
     1. Body explains "what" and "why", not "how"
   
   ### Documentation
   
   - [x] 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
   
   ### Code Quality
   
   - [x] Passes `flake8`
 
----------------------------------------------------------------
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


> Small typo and incorrect tests in CONTRIBUTING.md
> -------------------------------------------------
>
>                 Key: AIRFLOW-5239
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-5239
>             Project: Apache Airflow
>          Issue Type: Bug
>          Components: documentation
>    Affects Versions: 1.10.4
>            Reporter: Cooper Gillan
>            Assignee: Cooper Gillan
>            Priority: Trivial
>
> There is a small typo in CONTRIBUTING.md under the "Local virtualenv development environment" heading:
> bq. The tests in Airflow are a mixture of unit and integration tests and some of them require those components to be setup. Only real unit tests can be run bu default in local environment.
> Additionally, the section about running tests in the Docker container [lists only {{./scripts/ci/in_container/run_pylint.sh}}|https://github.com/apache/airflow/blob/master/CONTRIBUTING.md#running-static-code-analysis-in-the-docker-compose-environment] to run pylint tests, but both {{./scripts/ci/in_container/run_pylint_main.sh}} and {{./scripts/ci/in_container/run_pylint_tests.sh}} are both present.



--
This message was sent by Atlassian JIRA
(v7.6.14#76016)