Skip to content

Lint Tool Meeting Minutes

Meeting Info

Date 2022-08-26
Topic Discussion about Lint Tool Integration
Attendee Calvin Yan, Rocky Chi, Selly Huang, Daniel Zhou, Ted Zhao, Jackson Liu, Kevin Qian
Note Taker Rocky Chi
Timer Kevin Qian
Duration 60 minutes

Meeting Agenda

  1. Review MCT wiki - 5 mins
  2. Discussion on how to introduce Lint Tools into project - 30 mins

Meeting Minutes

1. Review MCT wiki

  • HEA AUX Links: We should link them to project wiki, not project portal.
  • Project Wiki Resource: Resources (JavaScript and CSS) of all project wiki should refer to HEA wiki, so that they can keep in same style.
  • How to integrate with SVTA and BOV: can be added in MCT wiki as a sub module, with some descriptions on project introduction.
  • Set up new wiki framework for all projects: recommend to set up new wiki framework according to HEA rules, but it can be postponed if team does not have enough resource to do it (EMS wiki).

2. Discussion on how to introduce Lint Tools into project

There are 3 types of integration: IDE Integration, GitHub Merge Integration, and Jenkins CICD Integration. Here are some example tools: - IDE Integration - Spectral: an open source JSON / YAML linter, can be integrated into IDE. - markdownlint: an extension for the Visual Studio Code editor that includes a library of rules to encourage standards and consistency for Markdown files. - Pylint: a static code analyser for Python 2 or 3. - SonarLint: IDE extension that helps you detect and fix quality issues as you write code - multiple languge support. - GitHub Integration - Codacy: Maintain code quality by blocking merges of pull requests based on personal quality rules - multiple languge support. - DeepSource: Analyzes every pull-request, automatically formats code, generate fixes for issues with Autofix - multiple languge support. - Jenkins Integration - SonarQube: It has thousands of automated static code analysis rules - multiple languge support - multiple languge support.

Action Items

  1. Link .js and .css files in MCT and UAS wiki to HEA wiki project.
  2. Research on each static code analysis tool and check if it is free to use.
  3. Need have a further disussion about how to introduce those lint tools into our project - next weekly meeting's topic.