python-gsoc / python-blogs

Python Software Foundation GSoC Blog Platform. This system was used until 2024 but is no longer maintained.
http://python-gsoc.org/
GNU Affero General Public License v3.0
41 stars 60 forks source link

GSoC 2019 - Add a linter #75

Closed dotgourav closed 5 years ago

dotgourav commented 5 years ago

Is your feature request related to a problem? Please describe. Add linting support. Linting would help us maintain code quality and hence help new contributors understand the code better.

Describe the solution you'd like Add flake8 with these plugins: flake8-docstrings, pep8-naming, flake8-import-order

I suggest using the Pre-commit framework for doing it. This would automate the checking of predefined hooks like flake8(https://flake8.pycqa.org/en/latest/user/using-hooks.html)

botanicvelious commented 5 years ago

Related to #7

dotgourav commented 5 years ago

I believe #7 should be broken down into issues such as:

Since 1 & 2 can be done fairly quickly and the project could use it right now as there are over 100 PEP8,PEP257 violations.

@botanicvelious What are your thoughts on it?

botanicvelious commented 5 years ago

Oh, I wasn't saying to add tests, just the framework, 👍

sharmaadityaHQ commented 5 years ago

I would like to take this up. Please guide me on how to get started with this.

botanicvelious commented 5 years ago

you would need to look at adding the approprate files, such as pylint.cfg landscape.yml and travis.yml for example