diff options
Diffstat (limited to 'docs/content/doc/usage/issue-pull-request-templates.en-us.md')
-rw-r--r-- | docs/content/doc/usage/issue-pull-request-templates.en-us.md | 64 |
1 files changed, 35 insertions, 29 deletions
diff --git a/docs/content/doc/usage/issue-pull-request-templates.en-us.md b/docs/content/doc/usage/issue-pull-request-templates.en-us.md index 0bc8f0eb7c..44291635c9 100644 --- a/docs/content/doc/usage/issue-pull-request-templates.en-us.md +++ b/docs/content/doc/usage/issue-pull-request-templates.en-us.md @@ -3,7 +3,7 @@ date: "2018-05-10T16:00:00+02:00" title: "Usage: Issue and Pull Request templates" slug: "issue-pull-request-templates" weight: 15 -toc: true +toc: false draft: false menu: sidebar: @@ -15,6 +15,10 @@ menu: # Issue and Pull Request Templates +**Table of Contents** + +{{< toc >}} + 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 main branch of the repository so that they can autopopulate the form when users are @@ -23,53 +27,55 @@ of getting some clarifying details. Possible file names for issue templates: -* ISSUE_TEMPLATE.md -* issue_template.md -* .gitea/ISSUE_TEMPLATE.md -* .gitea/issue_template.md -* .github/ISSUE_TEMPLATE.md -* .github/issue_template.md - +- `ISSUE_TEMPLATE.md` +- `issue_template.md` +- `.gitea/ISSUE_TEMPLATE.md` +- `.gitea/issue_template.md` +- `.github/ISSUE_TEMPLATE.md` +- `.github/issue_template.md` Possible file names for PR templates: -* 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 - +- `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` 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. -# Issue Template Directory +## Issue Template Directory Alternatively, users can create multiple issue templates inside a special directory and allow users to choose one that more specifically addresses their problem. Possible directory names for issue templates: -* ISSUE_TEMPLATE -* issue_template -* .gitea/ISSUE_TEMPLATE -* .gitea/issue_template -* .github/ISSUE_TEMPLATE -* .github/issue_template -* .gitlab/ISSUE_TEMPLATE -* .gitlab/issue_template +- `ISSUE_TEMPLATE` +- `issue_template` +- `.gitea/ISSUE_TEMPLATE` +- `.gitea/issue_template` +- `.github/ISSUE_TEMPLATE` +- `.github/issue_template` +- `.gitlab/ISSUE_TEMPLATE` +- `.gitlab/issue_template` Inside the directory can be multiple issue templates with the form -```markdown ------ +```md +--- + name: "Template Name" about: "This template is for testing!" title: "[TEST] " labels: - - bug - - "help needed" ------ + +- bug +- "help needed" + +--- + This is the template! ``` |