google/open-location-code

Add pylint checks for Python code

Open

#327 opened on May 6, 2019

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Java (3,945 stars) (500 forks)batch import
help wantedpython

Description

Python got code formatting added in #326 - in addition we should add pylint checking as well to pick up common errors.

We could adopt the pylintrc from the YAPF project.

Note: The pylintrc and the YAPF style will need to agree - for example the indentation in YAPF is four spaces and the above pylintrc uses two spaces.

It will need to be added to the travis.yml, and all the issues (there will be lots) addressed.

Contributor guide

Tech stack
python
Domain
ci cdtesting
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python knowledgeBasic understanding of pylintFamiliarity with Travis CI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Review the existing Python code formatting changes in PR #326 to understand current setup. Examine the pylintrc from the YAPF project linked in the issue. Ensure the pylint configuration aligns with YAPF's style (e.g., indentation). Then modify the .travis.yml to add a pylint job, run pylint on the codebase, and fix all reported issues. Consider the balance between pylint rules and YAPF formatting.
Add pylint checks for Python code · google/open-location-code#327 | Good First Issue