allcontributors icon indicating copy to clipboard operation
allcontributors copied to clipboard

add github issue option

Open mpadge opened this issue 5 years ago • 7 comments

Add option to add_contributors() function to open a github issue with dummy text to ping all contributors that they've been acknowledged in the README. Once that issue exists, triggering the option can then add any new contributors via additional automated issue comments.

mpadge avatar Jul 08 '20 20:07 mpadge

The above commit adds the initial functionality to open a new issue using the github client.

TODO

  • [x] Add function to add more recent contributors to an existing issue
  • [ ] Add function to check whether gh is locally installed, and error if not
  • [ ] Handle issue opening when > 50 people are pinged, because github prevents more than that number being pinged from a single issue comment, so that case needs multiple comments.

mpadge avatar Aug 17 '20 10:08 mpadge

Re-opening coz still have to do the 2nd of those ~~, and also need to actually check that functionality works properly~~ - it all appears to work well with issue opening.

mpadge avatar Aug 18 '20 09:08 mpadge

Also, imagine I open an issue with a question and you end up telling me to rather open a discussion thread in a forum to get help. My contribution is then not really one. Could you label the issue as out-of-scope for the tool?

And regarding the original intent of this very issue, maybe it could be stated in the issue template instead?

maelle avatar Nov 05 '20 07:11 maelle

Yes, it would be very easy to label the issue as "out-of-scope" or "non-contrib" or something, but then again if issues really are not considered relevant contributions then they can simply be deleted. That was my initial thought at least, and the reason why i opted to retain a simpler acknowledge-all-type approach. A question is still a form of interest in, and presumably use of, the software. I guess for me the real issue in thinking about that was how such a label could be applied in a way that wasn't overtly negative. Label filtering in this context must necessarily be a filtering out, which is an inherently negative activity, so labels would work best if they contained a negation, but that is then potentially insulting. I tried but couldn't think of suitable non-negative labels that retained general applicability ("enquiry" comes close, but even then issues may be opened simply to comment without enquiry).

Any advice would be greatly appreciated! The whole issue extraction is graphql, so adding a labels field to the query would be totally easy, and this would be no trouble at all to implement. I just would like to do it in the most appropriate way possible.


Finally, I'm not sure exactly what you mean by this:

And regarding the original intent of this very issue, maybe it could be stated in the issue template instead?

Could you please explain a bit more? Thanks

mpadge avatar Nov 05 '20 11:11 mpadge

how would you delete an issue?

I was thinking the issue template could state there's a README section with contributions but then who reads that...

maelle avatar Nov 05 '20 12:11 maelle

Magic new-ish "delete issue" button:

image

I was thinking the issue template could state there's a README section with contributions ...

I think that is what it already does: https://github.com/mpadge/allcontributors/blob/126be32f5b51136099c2b176fd73253b139c4bb4/R/add-contributors.R#L377-L382

That's what you mean, right?

mpadge avatar Nov 05 '20 13:11 mpadge

aaah cool that one can delete issues.

by issue template I mean .github/ templates, that one sees when opening an issue.

maelle avatar Nov 05 '20 13:11 maelle