Skip to content

Commit f150a20

Browse files
committed
add documentation
1 parent eaadddd commit f150a20

File tree

3 files changed

+36
-0
lines changed

3 files changed

+36
-0
lines changed

custom/conf/app.ini.sample

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ FILE_MAX_SIZE = 3
6161
MAX_FILES = 5
6262

6363
[repository.pull-request]
64+
; List of prefixes used in Pull Request title to mark them as Work In Progress
6465
WORK_IN_PROGRESS_PREFIXES=WIP:,[WIP]
6566

6667
[ui]

docs/content/doc/advanced/config-cheat-sheet.en-us.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,10 @@ Values containing `#` or `;` must be quoted using `` ` `` or `"""`.
6262
HTTP protocol.
6363
- `USE_COMPAT_SSH_URI`: **false**: Force ssh:// clone url instead of scp-style uri when
6464
default SSH port is used.
65+
66+
### Repository - Pull Request (`repository.pull-request`)
67+
- `WORK_IN_PROGRESS_PREFIXES`: **WIP:,\[WIP\]**: List of prefixes used in Pull Request
68+
title to mark them as Work In Progress
6569

6670
## UI (`ui`)
6771

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
date: "2018-06-01T19:00:00+02:00"
3+
title: "Usage: Pull Request"
4+
slug: "pull-request"
5+
weight: 13
6+
toc: true
7+
draft: false
8+
menu:
9+
sidebar:
10+
parent: "usage"
11+
name: "Pull Request"
12+
weight: 13
13+
identifier: "pull-request"
14+
---
15+
16+
# Pull Request
17+
18+
## "Work In Progress" pull requests
19+
20+
Marking a pull request as being a work in progress will prevent that pull request from being accidentally merged. To mark a pull request as being a work in progress, you must prefix its title by `WIP:` or `[WIP]` (case insensitive). Those values are configurable in your `app.ini` file :
21+
22+
```
23+
[repository.pull-request]
24+
WORK_IN_PROGRESS_PREFIXES=WIP:,[WIP]
25+
```
26+
27+
The first value of the list will be used in helpers.
28+
29+
## Pull Request Templates
30+
31+
You can find more information about pull request templates into the dedicated page : [Issue and Pull Request templates](../issue-pull-request-templates)

0 commit comments

Comments
 (0)