diff options
| author | John Olheiser <john.olheiser@gmail.com> | 2020-09-11 09:48:39 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-11 10:48:39 -0400 |
| commit | 26c4a049da178993e5ccddcb50e7edc70a6bde5d (patch) | |
| tree | 494106117720ff3ad5f9e77a380c9397c3cfe10b /docs | |
| parent | dd1a651b5895cfdb8a141a56aa824ed4d082c41a (diff) | |
| download | gitea-26c4a049da178993e5ccddcb50e7edc70a6bde5d.tar.gz gitea-26c4a049da178993e5ccddcb50e7edc70a6bde5d.zip | |
Issue templates directory (#11450)
* Issue templates
Signed-off-by: jolheiser <john.olheiser@gmail.com>
* Add some comments, appease the linter
Signed-off-by: jolheiser <john.olheiser@gmail.com>
* Add docs and re-use dir candidates
Signed-off-by: jolheiser <john.olheiser@gmail.com>
* Add default labels to issue templates
Signed-off-by: jolheiser <john.olheiser@gmail.com>
* Generate swagger
Signed-off-by: jolheiser <john.olheiser@gmail.com>
* Suggested changes
Signed-off-by: jolheiser <john.olheiser@gmail.com>
* Update issue.go
* Suggestions
Signed-off-by: jolheiser <john.olheiser@gmail.com>
* Extract metadata from legacy if possible
Signed-off-by: jolheiser <john.olheiser@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content/doc/usage/issue-pull-request-templates.en-us.md | 37 |
1 files changed, 36 insertions, 1 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 a4fc51b81f..4f5da04cb6 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 @@ -41,4 +41,39 @@ Possible file names for PR templates: * .github/pull_request_template.md -Additionally, the New Issue page URL can be suffixed with `?body=Issue+Text` and the form will be populated with that string. This string will be used instead of the template if there is one. +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 + +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 + +Inside the directory can be multiple issue templates with the form + +```markdown +----- +name: "Template Name" +about: "This template is for testing!" +title: "[TEST] " +labels: + - bug + - "help needed" +----- +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 +`This template is for testing!`. When submitting an issue with the above example, the issue title would be pre-populated with +`[TEST] ` while the issue body would be pre-populated with `This is the template!`. The issue would also be assigned two labels, +`bug` and `help needed`. |