camaraproject / QualityOnDemand

Repository to describe, develop, document and test the QualityOnDemand API family
https://wiki.camaraproject.org/x/zwOeAQ
Apache License 2.0
41 stars 59 forks source link

Adding configuration for linting ruleset #270

Closed rartych closed 6 months ago

rartych commented 6 months ago

What type of PR is this?

Add one of the following kinds:

What this PR does / why we need it:

The changes follow the instructions in https://github.com/camaraproject/Commonalities/blob/main/documentation/API-linting-Implementation-Guideline.md

Which issue(s) this PR fixes:

Fixes #

Special notes for reviewers:

megalinter.yml was modified compared to the Commonalities artefact to include JAVA_CHECKSTYLE as it was already configured for this repository. .openapirc.yml was deleted as the Spectral configuration is in .spectral.yml

Changelog input

Linting ruleset configured in Github Actions

Additional documentation

CAMARA API Linting Rules Documentation

hdamker commented 6 months ago

@eric-murray @RandyLevensalor Would you review and approve as well? It should be merged before @jlurien is starting the split of the APIs (cf. https://wiki.camaraproject.org/display/CAM/2024-03-08+Quality+on+Demand+-+Meeting+Minutes)