Handle cold start problem with codemeta files

[dgarijo]

If a repo does not have a codemeta file, we should devise what the interaction with the bot would be:

• Is a sample codemeta file added in the issue?
• Does the user respond with "add_codemeta" or something like that so the bot does a PR?

This feature is needed to properly evaluate the bot, in my opinion. Otherwise it won't work great in many repos.

[francoto]

As a first step I would suggest adding a first step detecting that codemeta.json file is missing and use SOMef to generate one.

I would add it in the issue submitted and ask if user wants the bot to create PR with new codemeta file.

In a first stage, the "PR generation" function would not exists but we could submit this PR ourself and eventually add this function.

My question is :
if no codemeta.json exists is it worth doing the RSMetacheck analysis ? or skip it while no codemeta are present ?

[dgarijo]

If no codemeta.json exists, there still may be discrepancies detected in the repo. Maybe @Anas-Elhounsri can provide an example. But they will be more subtle than having a codemeta file

[francoto]

Autocodemeta would generate such warnings and pitfalls ?
Could we suggest the generated codemata with some pointers on the potential issue your are thinking about ?

Is this also considering the case where generating the codemata file would trigger pitfalls and warnings ? The maintainer contacted would then thinks the codemata generated is creating more issues than not having one.

[dgarijo]

I am not sure I get your concerns, @francoto.
somef may generate a codemeta file. I don't think it should trigger any pitfalls or warnings, I believe.

[francoto]

I misread/misunderstood your previous comments @dgarijo . I thought you were saying that the generated codemeta file would generate pitfalls and warnings but what you meant is that regardless of if codemeta file exists, RSMetacheck may find other pitfalls or warnings.

So your comment is that giving the codemeta file won't fix these issues.
I agree with this but what about it ? We should still provide the codemeta file no ?

[dgarijo]

I think so, yes. Even if we detect incosnistencies, we should provide a codemeta file if that file does not exist.

[vuillaut]

A summary

flowchart TB
    repo([Repository]) --> prev{codemeta.json?}

    gencode[Generate codemeta.json]
    prev -- No --> ana[Run Analysis] 
    prev -- No --> gencode --> issue
    prev -- Yes --> ana
    ana --> pitfalls{Pitfalls ?}
    issue[Open issue ]
    pitfalls -- Yes --> autocorrect{pitfalls can be fixed automatically ?} -- yes --> addsuggest[Add targeted fixes to suggestions] --> issue
    autocorrect -- no --> issue
    pitfalls -- No --> stop

Loading