2018-05-11 08:42:22 +08:00
---
date: "2018-05-10T16:00:00+02:00"
title: "Usage: Issue and Pull Request templates"
slug: "issue-pull-request-templates"
weight: 15
2020-12-09 14:47:06 +08:00
toc: false
2018-05-11 08:42:22 +08:00
draft: false
menu:
sidebar:
parent: "usage"
name: "Issue and Pull Request templates"
weight: 15
identifier: "issue-pull-request-templates"
---
# Issue and Pull Request Templates
2020-12-09 14:47:06 +08:00
**Table of Contents**
{{< toc > }}
2019-03-10 05:15:45 +08:00
Some projects have a standard list of questions that users need to answer
when creating an issue or pull request. Gitea supports adding templates to the
2020-11-28 14:12:22 +08:00
main branch of the repository so that they can autopopulate the form when users are
2019-03-10 05:15:45 +08:00
creating issues and pull requests. This will cut down on the initial back and forth
2019-01-28 23:23:59 +08:00
of getting some clarifying details.
2018-05-11 08:42:22 +08:00
Possible file names for issue templates:
2020-12-09 14:47:06 +08:00
- `ISSUE_TEMPLATE.md`
- `issue_template.md`
- `.gitea/ISSUE_TEMPLATE.md`
- `.gitea/issue_template.md`
- `.github/ISSUE_TEMPLATE.md`
- `.github/issue_template.md`
2018-05-11 08:42:22 +08:00
Possible file names for PR templates:
2020-12-09 14:47:06 +08:00
- `PULL_REQUEST_TEMPLATE.md`
- `pull_request_template.md`
- `.gitea/PULL_REQUEST_TEMPLATE.md`
- `.gitea/pull_request_template.md`
- `.github/PULL_REQUEST_TEMPLATE.md`
- `.github/pull_request_template.md`
2019-01-28 23:23:59 +08:00
2020-09-11 22:48:39 +08:00
Additionally, the New Issue page URL can be suffixed with `?title=Issue+Title&body=Issue+Text` and the form will be populated with those strings. Those strings will be used instead of the template if there is one.
2020-12-09 14:47:06 +08:00
## Issue Template Directory
2020-09-11 22:48:39 +08:00
2020-11-28 14:12:22 +08:00
Alternatively, users can create multiple issue templates inside a special directory and allow users to choose one that more specifically
2020-09-11 22:48:39 +08:00
addresses their problem.
Possible directory names for issue templates:
2020-12-09 14:47:06 +08:00
- `ISSUE_TEMPLATE`
- `issue_template`
- `.gitea/ISSUE_TEMPLATE`
- `.gitea/issue_template`
- `.github/ISSUE_TEMPLATE`
- `.github/issue_template`
- `.gitlab/ISSUE_TEMPLATE`
- `.gitlab/issue_template`
2020-09-11 22:48:39 +08:00
Inside the directory can be multiple issue templates with the form
2020-12-09 14:47:06 +08:00
```md
---
2020-09-11 22:48:39 +08:00
name: "Template Name"
about: "This template is for testing!"
title: "[TEST] "
2021-12-18 05:29:09 +08:00
ref: "main"
2020-09-11 22:48:39 +08:00
labels:
2020-12-09 14:47:06 +08:00
- bug
- "help needed"
---
2020-09-11 22:48:39 +08:00
This is the template!
```
In the above example, when a user is presented with the list of issues they can submit, this would show as `Template Name` with the description
2020-11-28 14:12:22 +08:00
`This template is for testing!` . When submitting an issue with the above example, the issue title would be pre-populated with
2020-09-11 22:48:39 +08:00
`[TEST] ` while the issue body would be pre-populated with `This is the template!` . The issue would also be assigned two labels,
2021-12-18 05:29:09 +08:00
`bug` and `help needed` , and the issue will have a reference to `main` .