Summary titles should reference what tool they are from (if any)

Question

Summary titles should reference what tool they are from (if any)

Closed this issue 9 months ago · 6 comments

Right now, the summaries for codemods are inconsistent. If they are fed by an external scanner tool, we should reference them in the beginning, like this:

(Acme) Improvement summary

E.g.,

(Sonar) Added missing @Override parameter

Answer 1 · 2024-03-07T16:40:05.000Z

Is using parens the formatting that you want? Should we make this consistent in Python?

Answer 2 · 2024-03-07T16:40:46.000Z

I almost wonder whether CodeTF should have another (optional) field for this and maybe upstream tools should decide how to render it so that it's consistent?

Answer 3 · 2024-03-07T16:41:57.000Z

That seems way better. I mean, it's sort of guessable based on the codemod ID.

Answer 4 · 2024-03-07T16:42:41.000Z

Yeah true. I'll open a PR in https://github.com/pixee/codemodder-specs/pulls

Answer 5 · 2024-03-08T18:47:26.000Z

@drdavella this issue should be closed now, right? We should open another ticket to meet that spec.

Answer 6 · 2024-03-08T18:54:05.000Z

Yeah I think so unless you need this in the short term.