Write a text for outreach

[jspaaks]

Now that we have released version 2.0.0, we could reach out to some folks on GitHub to add the "cffconvert --validate" workflow to their repos via a Pull Request. It's probably a good start to limit this outreach to repos:

1. that already use CITATION.cff files
2. that have other workflows on GitHub Actions
3. that still see some development, preferably with multiple contributors
4. that work with Pull Requests
5. that do not already use a different validator
6. that did not previously receive a similar Pull Request from us
7. (during testing) that occur in the list of repos from research-software.nl/api/software
8. (during testing) LIMIT 20

Once we have a draft text for a Pull Request that adds cffconvert, I suggest we try it out on our colleagues first. If we're happy with their feedback, we can use GitHub search to find other repos that qualify according to the bullet points above, and send them a PR as well.

[jspaaks]

If we decide to automate some of the above steps, I suggest we use a library to query github, e.g. using any of these https://docs.github.com/en/rest/overview/libraries

[abelsiqueira]

We could try looking for people who have updated or fixed their CITATION.cff file.

[jspaaks]

I suggest splitting the "filtering" (basically the steps above) from the "sending a PR" part. Basically the filtering should result in a curated list of repos.

[fdiblen]

We (@jspaaks, @abelsiqueira, @fdiblen), decided to remove item 3 and add

• Check if they accept PRs from external contributors
• Check and follow CONTRIBUTIN..md if that exists
• Check if CITATION.cff file was updated before

[fdiblen]

The final list for

filtering:

1. that already use CITATION.cff files
2. that have other workflows on GitHub Actions
3. that work with Pull Requests
4. that do not already use a different validator
5. that did not previously receive a similar Pull Request from us
6. Check if they accept PRs from external contributors
7. Check and follow CONTRIBUTIN.md if that exists
8. Check if CITATION.cff file was updated before

sorting:

1. (during testing) that occur in the list of repos from research-software.nl/api/software
2. (during testing) LIMIT 30

[fdiblen]

We, GT, will first create an issue and ask developers whether they want us to create a PR. Based on the feedback we will create a PR.
For the interaction we will use @nlescgt account.

[jspaaks]

Found another thing to think about: nesting levels, e.g. https://github.com/unwitting-life/cpp-Qt/blob/573f035036485ebb72d6de977ba5bc51d4270385/lib/impl/nlohmann/json/CITATION.cff looks like a checked-in dependency, i.e. not the repo owner's job to correct.

[jspaaks]

What do we do with repos where the CITATION.cff file does not pass validation?

[fdiblen]

We will do the outreach work here: https://github.com/cffbots/filtering