mirror of
https://codeberg.org/forgejo/docs.git
synced 2024-11-24 18:09:26 -05:00
docs: 1.20: cherry-pick user/issue-pull-request-templates.md
* f384b13f1cd44be3a87df5553a0099390dacd010
This commit is contained in:
parent
c391904cf0
commit
f6378428f0
1 changed files with 38 additions and 0 deletions
|
@ -36,6 +36,17 @@ Possible file names for issue templates:
|
||||||
- `.github/issue_template.yaml`
|
- `.github/issue_template.yaml`
|
||||||
- `.github/issue_template.yml`
|
- `.github/issue_template.yml`
|
||||||
|
|
||||||
|
Possible file names for issue config:
|
||||||
|
|
||||||
|
- `.gitea/ISSUE_TEMPLATE/config.yaml`
|
||||||
|
- `.gitea/ISSUE_TEMPLATE/config.yml`
|
||||||
|
- `.gitea/issue_template/config.yaml`
|
||||||
|
- `.gitea/issue_template/config.yml`
|
||||||
|
- `.github/ISSUE_TEMPLATE/config.yaml`
|
||||||
|
- `.github/ISSUE_TEMPLATE/config.yml`
|
||||||
|
- `.github/issue_template/config.yaml`
|
||||||
|
- `.github/issue_template/config.yml`
|
||||||
|
|
||||||
Possible file names for PR templates:
|
Possible file names for PR templates:
|
||||||
|
|
||||||
- `PULL_REQUEST_TEMPLATE.md`
|
- `PULL_REQUEST_TEMPLATE.md`
|
||||||
|
@ -250,3 +261,30 @@ For each value in the options array, you can set the following keys.
|
||||||
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ------- | ------- |
|
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ------- | ------- |
|
||||||
| label | The identifier for the option, which is displayed in the form. Markdown is supported for bold or italic text formatting, and hyperlinks. | Required | String | - | - |
|
| label | The identifier for the option, which is displayed in the form. Markdown is supported for bold or italic text formatting, and hyperlinks. | Required | String | - | - |
|
||||||
| required | Prevents form submission until element is completed. | Optional | Boolean | false | - |
|
| required | Prevents form submission until element is completed. | Optional | Boolean | false | - |
|
||||||
|
|
||||||
|
## Syntax for issue config
|
||||||
|
|
||||||
|
This is a example for a issue config file
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
blank_issues_enabled: true
|
||||||
|
contact_links:
|
||||||
|
- name: Gitea
|
||||||
|
url: https://gitea.io
|
||||||
|
about: Visit the Gitea Website
|
||||||
|
```
|
||||||
|
|
||||||
|
### Possible Options
|
||||||
|
|
||||||
|
| Key | Description | Type | Default |
|
||||||
|
| -------------------- | ----------------------------------------------------- | ------------------ | ----------- |
|
||||||
|
| blank_issues_enabled | If set to false, the User is forced to use a Template | Boolean | true |
|
||||||
|
| contact_links | Custom Links to show in the Choose Box | Contact Link Array | Empty Array |
|
||||||
|
|
||||||
|
### Contact Link
|
||||||
|
|
||||||
|
| Key | Description | Type | Required |
|
||||||
|
| ----- | -------------------------------- | ------ | -------- |
|
||||||
|
| name | the name of your link | String | true |
|
||||||
|
| url | The URL of your Link | String | true |
|
||||||
|
| about | A short description of your Link | String | true |
|
||||||
|
|
Loading…
Reference in a new issue