[jira] [Commented] (AIRFLOW-4364) Integrate Pylint

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

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

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

BasPH commented on pull request #5391: [AIRFLOW-4364] Allow module names to begin with 0-9 and max 60 chars
URL: https://github.com/apache/airflow/pull/5391
 
 
   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. For example, "\[AIRFLOW-XXX\] My Airflow PR"
     - https://issues.apache.org/jira/browse/AIRFLOW-XXX
     - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
     - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
     - In case you are adding 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 any UI changes:
   
   ### Tests
   
   - [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
   
   ### Commits
   
   - [ ] 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
   
   - [ ] 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
   
   - [ ] 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


> Integrate Pylint
> ----------------
>
>                 Key: AIRFLOW-4364
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-4364
>             Project: Apache Airflow
>          Issue Type: Improvement
>          Components: ci
>    Affects Versions: 2.0.0
>            Reporter: Bas Harenslak
>            Priority: Major
>
> After a [vote on the mailing list|https://lists.apache.org/thread.html/f4940d36e98ded96a2473bb2ccdfa4cc648faa2c1334b2aa901c0bba@%3Cdev.airflow.apache.org%3E] everybody voted for pylint integration.
> Making the whole project Pylint compatible is a lot of work and big change. Therefore we split up all the work in subissues under this issue. The approach is as follows:
> All files are currently blacklisted from Pylint. The blacklist is stored in scripts/ci/pylint_todo.txt. Every subissue relates to one or more files on the blacklist. Once you start on an issue:
>  # (running scripts/ci/ci_pylint.sh on master should produce no messages)
>  # Remove the files mentioned in your issue from the blacklist
>  # Run scripts/ci/ci_pylint.sh to see all messages on the no longer blacklisted files
>  # Fix all messages and create PR
> *Why a separate blacklist file and not use Pylint's --ignore-pattern to ignore files?*
>  --ignore-pattern only works on base filenames, not paths.
> *Why don't you blacklist patterns, where 1 line relates to 1 JIRA issue?*
>  Creating a list of non-overlapping patterns proved difficult, this was the pragmatic solution.
> *Rule X is too strict. Can we disable it?*
> In the first PR ([https://github.com/apache/airflow/pull/5238]) we made a choice on every error found on Airflow master back then. While at occasions it might seem harsh to be strict on the code, Airflow is an open source project with many contributors from all over the world. Others read the code without the thought process you put into the code and it helps to have e.g. descriptive variable names, docstrings and sticking to Python conventions. This helps the collaboration between everybody and even your future self. Typically, this question suggests one is trying to lower the boundaries. If you believe there is a valid reason for doing so, please add it to the PR and explain the reason.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)