scripts icon indicating copy to clipboard operation
scripts copied to clipboard

Add annotations to the filename script so that a PR raised would notify the contributors about the files that don't follow the guideline

Open tjgurwara99 opened this issue 2 years ago • 3 comments

This is an issue to track the adding annotations to the filename script.

What do we mean by annotations? The following is an example of an annotation generated by a linter called golangci-lint. Generating them is quite straight forward, the docs explain this quite nicely. Screenshot 2023-03-08 at 23 35 17

tjgurwara99 avatar Mar 08 '23 23:03 tjgurwara99

This is an awesome idea! 🚀 Let me know when you'll start working on it, and if you need any help.

Panquesito7 avatar Jun 11 '23 22:06 Panquesito7

For the C++ one, I think what we should do is create a subprocess runner which parses the output of the linters and creates the annotations so that it can integrate well with GitHub. Have you got any experience working on parsers? It doesn't have to be fancy, you just need to take the output of another program and feed it into your program - I recommend Go or Python if you wanna start with it this parser part?

tjgurwara99 avatar Jun 13 '23 16:06 tjgurwara99

I'm not experienced with that, actually, never heard of it. 👀 I guess we can work together on that, though.

Panquesito7 avatar Jun 13 '23 16:06 Panquesito7