Demo proposal: Set up a CI with linting and SonarCloud checks, week 2

[williamnordwall]

Assignment Proposal

Title

Setup automated linting and code checks with SonarCloud

Names and KTH ID

• William Nordwall (wcvno@kth.se)
• Samuel Flodin (samflo@kth.se)

Deadline

• Week 2

Category

• Demo

Description

We want to set up a GitHub Actions CI which runs linting on each PR to check for correct formatting.
The CI will also use SonarCloud to scan the code for code quality issues. These can be issues such as unused variables, functions with high complexity or having poor test coverage (<80%).

In the demo we will first show a functioning application. We will then demonstrate what happens if we push code that is poorly formatted or has one or more of the issues above that SonarCloud will find.

Relevance

Ensuring high code quality is an important part of DevOps.
Linting code to check for correct formatting helps with clarity, and using SonarCloud to check for code issues such as the ones mentioned above also improves the quality of the code.

[algomaster99]

The group folder should be inside a week folder !

[frankreyesgarcia]

Hi, the proposal sounds good. Please clarify what other issues you want to report.

[iAmSamFlo]

@frankreyesgarcia We've added some clarifications as recommended. Please let us know if you need more.