readme: Add best practices, overview, and run explanation #232

	# This workflow will build a golang project
	# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go

	name: Sonar Report

	on:
	push:
	branches: [ "main" ]
	pull_request:
	branches: [ "main" ]

	jobs:

	build:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4

	- name: Set up Go
	uses: actions/setup-go@v5
	with:
	go-version: '1.22'

	- name: Generate Sonar Report
	run: go test -coverpkg=./... -coverprofile=coverage.out -json ./... > sonar-report.json

	- name: Upload coverage reports to Sonar
	uses: sonarsource/sonarcloud-github-action@master
	env:
	SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

Provide feedback