Azure-Samples / apim-genai-gateway-toolkit

A repo to accelerate development and testing of GenAI Gateways built with Azure API Management. Includes various capabilities as examples/starters.
MIT License
39 stars 14 forks source link

Add markdownlint #70

Closed stuartleeks closed 2 months ago

stuartleeks commented 2 months ago

Purpose

Fix simple linting issues Add linter config to disable some rules for now Add GH workflow to run linter on PRs

Does this introduce a breaking change?

[ ] Yes
[X] No

Pull Request Type

What kind of change does this Pull Request introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[X] Documentation content changes
[ ] Other... Please describe:

How to Test

git clone [repo-address]
cd [repo-name]
git checkout [branch-name]
npm install

What to Check

Verify that the following are valid

Other Information

stuartleeks commented 2 months ago

Should we add a note to the README on how to run the linter locally? Or assume the user will figure that out/use the GitHub workflow when merging?

Good point - just added to the contributing doc