all-contributors / all-contributors/cli

Add documentation about passing URL as part of contribution

未关闭
#282 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
pinned
主要语言
JavaScript
星标
425
派生
149
PR 合并指标
30 天内没有已合并 PR

描述

(forked from all-contributors/cli#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=` 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!

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。