cli icon indicating copy to clipboard operation
cli copied to clipboard

Breaking change: update default URL behavior

Open jamesplease opened this issue 8 years ago • 9 comments

:wave: Hi again!

I'm opening up this issue because this feature seems unexpected to me. I could see someone maybe adding these URLs to their projects, but it seems like that would be the exception, rather than the default.

For instance, the all-contributors project itself doesn't include links like this. I didn't check all of the projects, but it's probably a safe bet that none of the projects listed in the implementations list use these links, either.

Does anyone else think it would make more sense to default these sorts of contribution types to having no link? Right now, if most of the contributions have links that don't work, then that could possibly distract from the links that actually do point somewhere useful.

No big deal either way, but I figured I'd open this up for discussion.

Thanks for reading!

jamesplease avatar Aug 03 '17 23:08 jamesplease

Yeah, I've considered this. The spec actually mentions that if someone's contributed content (like a video) those links should point to their content. But it's kinda hard to automate that. Trade-offs with the amount of time we have to work on this.

If you want to change it so we only have the link for certain contribution types that'd be fine :+1:

kentcdodds avatar Aug 03 '17 23:08 kentcdodds

But it's kinda hard to automate that. Trade-offs with the amount of time we have to work on this.

:+1: makes sense.

If you want to change it so we only have the link for certain contribution types that'd be fine 👍

Cool. I'll do this sometime soon.

If anyone feels strongly against this change, then that's alright, too. It can just as easily be left alone. It's a small thing, really.

jamesplease avatar Aug 03 '17 23:08 jamesplease

Well, to expand on this, what if we defaulted to no link, BUT if there is an array in the array, then the first will be the type and the second would be a url to associated.

So for instance, I could have a section of videos or tuts or something like:

{
  "contributors": [
    {
      "login": "evilsoft",
      "name": "Ian Hofmann-Hicks",
      "avatar_url": "https://avatars1.githubusercontent.com/u/3665793?v=4",
      "profile": "https://github.com/evilsoft",
      "contributions": [
        "code",
        "doc",
        [ "video", "#ian-hofmann-hicks-videos" ]
      ]
    }
  ]
}

Videos

Ian Hofmann-Hicks Videos

The only issue is, how the heck to specify it on the command line.

OR leave the default behavior as is, and then use the link if specified then it is a minor change and not a breaking change.

evilsoft avatar Feb 27 '18 05:02 evilsoft

I'd love it if we could add a linking capability and the suggestion here looks perfect :+1:

I'd be happy to accept a PR for this :+1:

kentcdodds avatar Mar 02 '18 00:03 kentcdodds

if @jamesplease does not wanna grab It I would be more than happy too!!

evilsoft avatar Mar 02 '18 00:03 evilsoft

The only thing that is questionable or may raise :eye: brows will be how to specify in command line, it would be best to not have the user edit this file if they do not have to IMO. But I have an idea I will throw it up the mast and see who salutes.

evilsoft avatar Mar 02 '18 00:03 evilsoft

Go for it @evilsoft !

jamesplease avatar Mar 02 '18 01:03 jamesplease

@evilsoft @jamesplease Have either of you worked something out for this?

Berkmann18 avatar Jan 18 '19 16:01 Berkmann18

@evilsoft @jamesplease Friendly ping.

Berkmann18 avatar Mar 23 '21 11:03 Berkmann18

@all-contributors/core I'm looking forward to this one however I like the implementation in this one

tenshiAMD avatar Sep 14 '22 19:09 tenshiAMD

Closing this for now. Let's move this to https://github.com/all-contributors/cli/issues/88.

tenshiAMD avatar Sep 14 '22 20:09 tenshiAMD

Many contributions don't take the form of GitHub issues, so I don't think the proposal in #88 makes much sense, either. But it is an improvement over the current behavior.

jamesplease avatar Sep 15 '22 14:09 jamesplease