Commit efb5dff3 authored by Rachel Gottesman's avatar Rachel Gottesman Committed by Marcin Sedlak-Jakubowski

Fix future tense issues

parent b4c3ebcd
...@@ -26,7 +26,7 @@ are added to the root directory of a GitLab project's repository. ...@@ -26,7 +26,7 @@ are added to the root directory of a GitLab project's repository.
Description templates must be written in [Markdown](../markdown.md) and stored Description templates must be written in [Markdown](../markdown.md) and stored
in your project's repository under a directory named `.gitlab`. Only the in your project's repository under a directory named `.gitlab`. Only the
templates of the default branch will be taken into account. templates of the default branch are taken into account.
## Use-cases ## Use-cases
...@@ -53,7 +53,7 @@ To create a Markdown file: ...@@ -53,7 +53,7 @@ To create a Markdown file:
example `feature_request.md` or `Feature Request.md`. example `feature_request.md` or `Feature Request.md`.
1. Commit and push to your default branch. 1. Commit and push to your default branch.
If you don't have a `.gitlab/issue_templates` directory in your repository, you'll need to create it. If you don't have a `.gitlab/issue_templates` directory in your repository, you need to create it.
To create the `.gitlab/issue_templates` directory: To create the `.gitlab/issue_templates` directory:
...@@ -74,10 +74,10 @@ push to your default branch. ...@@ -74,10 +74,10 @@ push to your default branch.
## Using the templates ## Using the templates
Let's take for example that you've created the file `.gitlab/issue_templates/Bug.md`. Let's take for example that you've created the file `.gitlab/issue_templates/Bug.md`.
This will enable the `Bug` dropdown option when creating or editing issues. When This enables the `Bug` dropdown option when creating or editing issues. When
`Bug` is selected, the content from the `Bug.md` template file will be copied `Bug` is selected, the content from the `Bug.md` template file is copied
to the issue description field. The 'Reset template' button will discard any to the issue description field. The **Reset template** button discards any
changes you made after picking the template and return it to its initial status. changes you made after picking the template and returns it to its initial status.
TIP: **Tip:** TIP: **Tip:**
You can create short-cut links to create an issue using a designated template. For example: `https://gitlab.com/gitlab-org/gitlab/-/issues/new?issuable_template=Feature%20proposal`. You can create short-cut links to create an issue using a designated template. For example: `https://gitlab.com/gitlab-org/gitlab/-/issues/new?issuable_template=Feature%20proposal`.
...@@ -92,7 +92,7 @@ You can create short-cut links to create an issue using a designated template. F ...@@ -92,7 +92,7 @@ You can create short-cut links to create an issue using a designated template. F
The visibility of issues and/or merge requests should be set to either "Everyone The visibility of issues and/or merge requests should be set to either "Everyone
with access" or "Only Project Members" in your project's **Settings / Visibility, project features, permissions** section, otherwise the with access" or "Only Project Members" in your project's **Settings / Visibility, project features, permissions** section, otherwise the
template text areas won't show. This is the default behavior so in most cases template text areas don't show. This is the default behavior, so in most cases
you should be fine. you should be fine.
1. Go to your project's **Settings**. 1. Go to your project's **Settings**.
...@@ -108,7 +108,7 @@ you should be fine. ...@@ -108,7 +108,7 @@ you should be fine.
![Default issue description templates](img/description_templates_issue_settings.png) ![Default issue description templates](img/description_templates_issue_settings.png)
After you add the description, hit **Save changes** for the settings to take After you add the description, hit **Save changes** for the settings to take
effect. Now, every time a new merge request or issue is created, it will be effect. Now, every time a new merge request or issue is created, it is
pre-filled with the text you entered in the template(s). pre-filled with the text you entered in the template(s).
## Description template example ## Description template example
...@@ -119,7 +119,7 @@ for some examples. ...@@ -119,7 +119,7 @@ for some examples.
TIP: **Tip:** TIP: **Tip:**
It's possible to use [quick actions](quick_actions.md) within description templates to quickly add It's possible to use [quick actions](quick_actions.md) within description templates to quickly add
labels, assignees, and milestones. The quick actions will only be executed if the user submitting labels, assignees, and milestones. The quick actions are only executed if the user submitting
the issue or merge request has the permissions to perform the relevant actions. the issue or merge request has the permissions to perform the relevant actions.
Here is an example of a Bug report template: Here is an example of a Bug report template:
......
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