Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

allcontributors[bot] mentions himself as missing contributor #265

Open
smeijer opened this issue May 28, 2020 · 7 comments
Open

allcontributors[bot] mentions himself as missing contributor #265

smeijer opened this issue May 28, 2020 · 7 comments

Comments

@smeijer
Copy link

smeijer commented May 28, 2020

  • all-contributors-cli version: 6.15.0
  • node version: v12.16.1
  • npm (or yarn) version: 6.14.0

Relevant code or config

➜ npx all-contributors-cli check

What you did:

  1. I made the all-contributors bot open a few pull-requests to get people added to the readme. (by mentioning the bot in a couple of issues)
  2. If I now run the all-contributors-cli check script at my terminal, to see if I've missed someone, it mentions that the bot itself is missing.

What happened:

npx: installed 109 in 4.949s
Missing contributors in .all-contributorsrc:
    allcontributors[bot]

Reproduction repository:

git clone [email protected]:smeijer/testing-playground.git
cd testing-playground
git reset 7a66910ee69423151e222a308cbe66a945d961bc --hard

npx all-contributors-cli check

Problem description:

I realize, this project is about acknowledging ALL contributors, but still. Even the bots?

Suggested solution:

Add an option to ignore bots. (or just make it the default)

@Berkmann18
Copy link
Member

I see why one would ignore bots in such a list and as you mentioned, the point of All Contributors is to recognise any contributors.
No one is obligating you to add bots in your .all-contributorsrc list so that's up to you if you want to recognise them. On the other hand, some people do recognise bots as contributors (at least from what I've seen), and there's no problem with that.

I guess it might be a feature some would be interested in having.

@smeijer
Copy link
Author

smeijer commented May 29, 2020

Thinking about this a bit more, I start to understand the value of recognizing bots.

Maybe we can indeed make it configurable? And/or add a new emojikey?

The following idea's come to mind, no idea if it fit's all in the idea of this project, feel free to burn them at any time:

  • add option to ignore bots, (dependable, imgbot, contributorbot, ...)

  • add option to recognize them under a dedicated "bots" heading, so they don't end up mixed with "humans"

  • add a new emoji key type: 🤖 bot

I haven't checked, but if I would now add them, will their "profile" link to something existing? I think linking popular bots to their project pages, will benefit the maintainers of that bot. If not:

  • add a list of popular bots, and link the bot mention to their project page.

@Berkmann18
Copy link
Member

Berkmann18 commented May 29, 2020

Maybe we can indeed make it configurable? And/or add a new emojikey?

A configuration would be better considering that some bots cover specific categories (which may not be obvious to certain people).

add option to ignore bots, (dependable, imgbot, contributorbot, ...)

Sounds doable and not too demanding on refactoring.

add option to recognize them under a dedicated "bots" heading, so they don't end up mixed with "humans"

This would be better IMO, I guess some kind of checks would need to be considered to not have such section if there are 0 bots in the contributor's list.

I haven't checked, but if I would now add them, will their "profile" link to something existing? I think linking popular bots to their project pages, will benefit the maintainers of that bot. If not:

Afaik bots like Dependabot, Semantic Release Bot and Snyk bot links to the main website as shown on one of my repos with all three in the table.
Same goes for Codacy Badger and ImgBot as shown in here.

So it does link to the bot maintainers in some way.

@smeijer
Copy link
Author

smeijer commented May 29, 2020

So it does link to the bot maintainers in some way.

Exactly what I meant. Awesome.

@Berkmann18
Copy link
Member

Coming back to this, have you thought of a way to implement this?

@tenshiAMD
Copy link
Member

Coming back to this, have you thought of a way to implement this?

@Berkmann18 I think we can do for this is to add ignoreContributors option that will skip those unwanted contributors

@Berkmann18
Copy link
Member

@tenshiAMD Absolutely.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants