Commit 674247f6 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Document issues and merge requests template feature

[ci skip]
parent 7d415465
......@@ -16,6 +16,7 @@
- [Web hooks](web_hooks/web_hooks.md) Let GitLab notify you when new code has been pushed to your project.
- [Workflow](workflow/README.md) Using GitLab functionality and importing projects from GitHub and SVN.
- [GitLab Pages](pages/README.md) Using GitLab Pages.
- [Custom templates for issues and merge requests](customization/issue_and_merge_request_template.md) Pre-fill the description of issues and merge requests to your liking.
## CI Documentation
......
# Custom templates for issues and merge requests
_**Note:** Templates for merge requests were [introduced][ee-7478ece] in GitLab
EE 6.9. Templates for issues were [introduced][ee-28] in GitLab EE 8.1._
---
We all know that a properly submitted issue is more likely to be addressed in
a timely manner by the developers of a project.
Templates help filter out a lot of unnecessary noise from issues, and with
GitLab you can do that pretty easily.
## Issues template
_**Note:** Make sure that the issues feature is enabled in your project's
**Settings** otherwise the template won't show. This is the default behavior so
in most cases you should be fine._
To enable the template feature for your issues, go to your project's
**Settings** and fill in the _Description template_ text area under the
**Issues** feature.
Since GitLab issues support [Markdown](../markdown/markdown.md), you can use
special markup like headings.
![Issue template in project settings](img/issue_and_merge_request_template_issue_settings.png)
---
After you add the description, hit **Save** for the settings to take effect.
Now, every time a new issue is created, it will be pre-filled with the text you
entered in the template.
![Issue template - new issue](img/issue_and_merge_request_template_new_issue.png)
---
## Merge requests template
_**Note:** Make sure that the merge requests feature is enabled in your project's
**Settings** otherwise the template won't show. This is the default behavior so
in most cases you should be fine._
As with [issues](#issues-template), you can create a template for your merge
requests as well. Remember that GitLab supports [Markdown](../markdown/markdown.md)
in merge requests.
![Issue template in project settings](img/issue_and_merge_request_template_mr_settings.png)
---
From now on, any new merge request will be pre-filled with the template text.
![Issue template - new MR](img/issue_and_merge_request_template_new_mr.png)
[ee-28]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/28 "Merge Request for adding issues template"
[ee-7478ece]: https://gitlab.com/gitlab-org/gitlab-ee/commit/7478ece8b48e80782b5465b96c79f85cc91d391b "Commit that introduced merge requests templates"
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment