Skip to content

Lint tool and Python rule discussion

Meeting Info

Date 2022-09-22
Topic Pylint, ESlint, Checkstyle report research status synchronization and Python rules part1 discussion
Attendee Calvin Yan, Selly Huang, Rocky Chi, Daniel Zhou, Ted Zhao, Jackson Liu, Kevin Qian
Note Taker Rocky Chi
Timer Jackson Liu
Duration 80 minutes

Meeting Agenda

  1. Sync Pylint, ESLint, Checkstyle report research status (if capable) - 15 mins
  2. Discuss on Python rules - 30 mins
  3. Discuss on how to balance task priority between Scrum Team and HEA.

Meeting Minutes

Lint tool report setup status

  • Checkstyle report status for UAS: Prepare the Checkstyle configuration
  • ESLint report status for UAS: Not started
  • Pylint report status for EMS: Plugin Warnings Next Generation seems not compatible with Pylint, but good news is Violations plugin is working fine for both report and report history.
  • Checkstyle report status for MCT: Not started

Discuss on Python rules

Python rules vote result as below: pylint-rule-part1

Some highlights: 1. Maximum Line Length rule limits all lines to a maximum of 79 characters, which is controversial. Team's suggestion is to set the max length to 120 (same as the default value of PyCharm), and make this rule as Recommended. 2. Names to Avoid rule needs to expand: recommend not to use other meaningless variables. 3. Let's make all comments related rule as Recommended, since it's hard for Pylint to detect. 4. Do not add too many items under single rule, it's not a good practice for Daily Tip too.

How to balance task priority between Scrum Team and HEA

  1. Teams members can communicate actively in HEA's Room to sync our task status.
  2. Task owners no need to be stressed for HEA's task, they can handle the priority themselves.
  3. If there do have risk for certain tasks, please raise it proactively in HEA's Room too.

Action Items

  1. Kevin will confirm if the order of self will affect the Python function
  2. We don't necessarily to go through all the task status of current sprint, it's fine to leave it to next week.
  3. Timer of the Meeting has the right to control the meeting's tempo and make sure we finish all the meeting topics first. If there are some points to brainstorm during the meeting, leave it afterwards.

Reference

PEP 8 – Style Guide for Python Code