Code Check Tool Meeting Minutes

Meeting Info ¶

Meeting Agenda ¶

1. Continue discuss on how to introducing code check tool into out project (IDE integration, GitHub integration, Jenkins Integration) - 40 mins

Meeting Minutes ¶

1. Continue discuss how to introduce Lint Tools into project ¶

• Integrate Pylint in IDEA. Pylint is a static code analyser for Python 2 or 3.

• Integrate Checkstyle in IDEA. Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard. It is highly configurable and can be made to support almost any coding standard.

2. Integrate GitHub with Jenkins CI/CD ¶

• GitHub Checks enhance our code review process with GitHub. We are able to test our code with continuous integration apps and view check status, build details, and inline code annotations with GitHub.

• GitHub Checks Plugin in Jenkins. This plugin publishes checks to GitHub through GitHub Checks API. It implements the extension points defined in Checks API Plugin.

• GitHub Apps allow us to automate and improve our workflow. We can build integrations with the GitHub APIs to add flexibility and reduce friction in our own workflow.

• WebExSquared PR is a well-done reference to see.

Action Items ¶

A piority list of Code Quality check: 1. Able to generate reports from Jenkins after running Lint check according to HEA rules, and periodically publish those reports on a server. 2. Enable IDEA integration of Lint rules and generate reports locally. 3. Enable GitHub merge check and pull request check.

The thought to achieve this is first let Jenkins enable universe of rules from Google Java Style, Sun Code Conventions, and enable only subset of lint rules using checkstyle.conf. Then we gradually set more and more lint rules into checkstyle.conf and watch the code quality change on server reports.