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

Add documentation about passing URL as part of contribution #282

Open
melink14 opened this issue Sep 4, 2020 · 1 comment
Open

Add documentation about passing URL as part of contribution #282

melink14 opened this issue Sep 4, 2020 · 1 comment
Labels

Comments

@melink14
Copy link
Contributor

melink14 commented Sep 4, 2020

(forked from #329)

Describe the solution you'd like
The spec mentions various contribution types which accept a URL (video, blog etc) that aren't automatically handled by the bot/CLI. In the code, we can see that contribution can be a tuple of type and URL but it doesn't seem documented. (https://github.com/all-contributors/all-contributors-cli/blob/0c7559515698b6e24919d334cd1a3713afd3a200/src/contributors/__tests__/add.js#L65)

Via experimentation I found that passing --url=<url> works since that syntax allows you to apparently add arbitrary keys to the options object.

Questions:

  • Is this a feature that we want documented or is it meant to be not discoverable?
  • If we want it documented, is the description above correct or is there some more canonical way to use it?
  • How does it work with the bot, I couldn't see anything in the bot's code about extracting URLs so maybe it's not available there? If so it can be noted in the documentation.

After clarification I should be able to send a PR for this as well!

@Berkmann18 Berkmann18 transferred this issue from all-contributors/all-contributors Sep 6, 2020
@Berkmann18
Copy link
Member

Is this a feature that we want documented or is it meant to be not discoverable?

It should be documented.

If we want it documented, is the description above correct or is there some more canonical way to use it?

Not entirely sure, perhaps @jakebolam or one of the (former) maintainers who wrote that?

How does it work with the bot, I couldn't see anything in the bot's code about extracting URLs so maybe it's not available there? If so it can be noted in the documentation.

It's possibly one of the features that haven't been ported to the bot.

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

No branches or pull requests

3 participants