查询参数是 URL 中可以定制的部分,用于在 GitHub 上共享特定的网页视图,如搜索过滤结果或议题模板。 要创建自己的查询参数,必须将键与值进行配对。
提示:也可使用默认标签、受理人和议题标题创建议题模板。 更多信息请参阅“为仓库配置议题模板”或“手动为仓库创建单一议题模板”。
必须具有适当的权限才可执行使用相关查询参数的操作。 例如,必须具有向议题添加标签的权限才可使用 labels
查询参数。
如果使用查询参数创建无效的 URL,或者没有适当的权限,URL 将返回 404 错误页。
支持的查询参数
查询参数 | 示例 |
---|---|
正文 | https://github.com/octo-org/octo-repo/compare/main...pull-request-test?quick_pull=1&body=Fixes+the+problem. 创建拉取请求,比较分支 main 与 pull-request-test ,在拉取请求正文中包含注释 "Fixes the problem"。 |
title | https://github.com/octo-org/octo-repo/issues/new?labels=bug&title=New+bug+report 使用标签 "bug" 和标题 "New bug report" 创建议题。 |
labels | https://github.com/octo-org/octo-repo/compare/main...pull-request-test?quick_pull=1&labels=bug 创建拉取请求,比较分支 main 与 pull-request-test ,加标签 "bug"。 |
模板 | https://github.com/octo-org/octo-repo/issues/new?template=issue_template.md 使用模板在议题正文中创建议题。 |
里程碑 | https://github.com/octo-org/octo-repo/issues/new?milestone=testing+milestones 创建包含里程碑 "testing milestones" 的议题。 |
assignees | https://github.com/octo-org/octo-repo/issues/new?assignees=octocat 创建议题并分配到 @octocat。 |
projects | https://github.com/octo-org/octo-repo/issues/new?title=Bug+fix&projects=octo-org/1 创建标题为 "Bug fix" 的议题并将其添加到组织的项目板 1。 |
使用自定义模板填写议题和拉取请求
这是用于创建议题模板的旧工作流程。 建议使用升级的多议题模板构建器来创建多个议题模板。 更多信息请参阅“关于议题和拉取请求模板”。
您可以使用 template
查询参数指定模板自动填充议题或拉取请求正文。 template
查询参数支持仓库根目录 docs/
或 .github/
的 ISSUE_TEMPLATE
或 PULL_REQUEST_TEMPLATE
子目录中的模板。
如果仓库只包含默认拉取请求或议题模板,则任何新议题或拉取请求在正文中都会有默认模板。
更多信息请参阅“为仓库创建拉取请求模板”或“手动为仓库创建单一议题模板”。