Skip to content

Commit

Permalink
Mention that pull requests cannot use issue forms
Browse files Browse the repository at this point in the history
  • Loading branch information
Calinou committed Aug 1, 2021
1 parent d9b86c6 commit 21de3d1
Showing 1 changed file with 8 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ You can create custom issue forms by adding a YAML form definition file to the `

When a contributor fills out an issue form, their responses for each input are converted to markdown and added to the body of an issue. Contributors can edit their issues that were created with issue forms and other people can interact with the issues like an issue created through other methods.

{% note %}
**Note:** Issue forms are not supported for pull requests. Only traditional [pull request templates](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository) can be used for pull requests.
{% endnote %}

This example YAML configuration file defines an issue form using several inputs to report a bug.

{% data reusables.community.issue-forms-sample %}
Expand Down Expand Up @@ -143,9 +147,9 @@ body:
- **Node**: 13.14.0
- **npm**: 7.6.3
value: |
- OS:
- Node:
- npm:
- OS:
- Node:
- npm:
render: markdown
validations:
required: false
Expand All @@ -154,7 +158,7 @@ body:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
Expand Down

0 comments on commit 21de3d1

Please sign in to comment.