Skip to content

Commit 8e2a493

Browse files
authored
Add the notification about 3 characters limitation for issue templates (#60756)
1 parent a027dcf commit 8e2a493

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ category:
3131

3232
![Screenshot of the preview of an issue template. To the right of the template name, a pencil icon is outlined in dark orange.](/assets/images/help/repository/issue-template-edit-button.png)
3333
1. To automatically set a default issue title, assign the issue to people with read access to the repository, or apply labels to issues raised from the template, use the fields under "Optional additional information." You can also add these details in the issue template with `title`, `labels`, `type`, or `assignees` in a YAML frontmatter format.
34+
> [!NOTE]
35+
> The template name must be more than 3 characters.
36+
3437
1. When you're finished editing and previewing your template, click **Propose changes** in the upper right corner of the page.
3538
1. In the "Commit message" field, type a commit message describing your changes.
3639
1. Below the commit message fields, select whether to commit your template directly to the default branch, or to create a new branch and open a pull request. For more information about pull requests, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).
@@ -50,6 +53,9 @@ Here is an example of an issue form configuration file.
5053

5154
{% data reusables.community.issue-forms-sample %}
5255

56+
> [!NOTE]
57+
> The `name` field must be more than 3 characters. If it's not, the template won't be shown when creating an issue.
58+
5359
Here is the rendered version of the issue form.
5460

5561
![Screenshot of a rendered issue form, with a mix of text fields and dropdown menus.](/assets/images/help/repository/sample-issue-form.png)

0 commit comments

Comments
 (0)