如果你曾经在 GitHub 上开发过自己的开源项目,那么你可能会遇到一个问题,就是如何让用户能够方便地提交反馈和建议。GitHub 本身提供了 issue 功能来用于用户提出问题和需求,但是你需要手动去审核和回复这些 issue。
gh-issues-for-comments 是一个可以将 GitHub issue 中用户的评论转换为 issue 的 npm 包。这样,开发者可以更轻松地与用户交流,同时在一个地方处理反馈和建议。本文将为大家介绍如何使用 gh-issues-for-comments 这一 npm 包。
安装 gh-issues-for-comments
安装 gh-issues-for-comments 这一 npm 包很简单,只需要在命令行中输入以下代码即可:
npm install gh-issues-for-comments
使用 gh-issues-for-comments
安装好 gh-issues-for-comments 后,我们需要配置一些东西才能使它正常工作:
- 创建 GitHub 应用 token
为了使用 gh-issues-for-comments 包,我们需要创建一个 GitHub 的应用 token。在 GitHub 上,点击头像,然后选择「Settings」,接着点击「Developer settings」,然后再点击「Personal access tokens」。点击「Generate new token」,在这里你可以创建自己的 token。
将生成的 token 复制到一个安全的地方。
- 获取仓库的 owner 和 repo 名称
在你的仓库页面 URL 中的 https://github.com/:owner/:repo
,owner
就是仓库所有者的用户名,repo
就是仓库的名称。
- 引入 gh-issues-for-comments 包
const Issues = require('gh-issues-for-comments');
- 创建 Issues 实例
-- -------------------- ---- ------- ----- ------ - --- -------- ----- --- -- ---- ------ --- -- ----- ------ --- -- ------ -- ----- --- --- -- --- ----- --- -- ----- --- -- --- ----- ----- ------ --- -- --- ----- -- ------- --- -- --- ----- -- ---
完成以上步骤后,你的 issues
实例就创建好了。
接下来,我们需要使用 issues.create()
方法来将评论转换为 issue:
issues.create().then((res) => { console.log(res); }).catch((err) => { console.error(err); });
以上代码中,我们使用 create()
方法创建一个 issue,并在控制台中输出结果。
示例代码
下面是一个完整的示例代码:
-- -------------------- ---- ------- ----- ------ - ---------------------------------- ----- ----- - --- -- ---------- ----- ---- - --- -- ------ ----- ----- - --- -- -- ------ -- ----- ----- ------ - --- -------- ------ ----- ------ --- --------- -- -- -- ----- --------- -- ---- ------ ----- -- ----- -- ------- ------------- -- -- --- -------------------------- -- - ----------------- -------------- -- - ------------------- ---
结语
gh-issues-for-comments 这一 npm 包可以帮助我们更好地与我们的用户交流和处理反馈和建议。使用这一包会让我们的开发过程更加高效,同时也可以让我们的用户感到更加贴心的服务。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055ea381e8991b448dbffa