Skip to content

Commit 012a41e

Browse files
authored
Fix checklist formatting and improve example section
Updated checklist and example variable values in the pull request template.
1 parent 7464984 commit 012a41e

File tree

1 file changed

+5
-10
lines changed

1 file changed

+5
-10
lines changed

.github/pull_request_template.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ Please mark the following checks done
2020
- [ ] Template file name follows the pattern `<providerId>.<serviceId>.json`
2121
- [ ] resource URL provided with `logoUrl` is actually served by a webserver
2222

23-
# Checklist of common prolems of issues (mark all the checkboxes after conducting the check). Comment on any point which is not fulfilled.
23+
# Checklist of common problems
24+
25+
Mark all the checkboxes after conducting the check. Comment on any point which is not fulfilled.
2426
- [ ] digital signatures are used and `syncPubKeyDomain` specified (yes, `warnPhishing` is an option, but some providers reject such templates by policy, so signing shall be a default)
2527
- [ ] `syncRedirectDomain` is specified when intended to use `redirect_uri` parameter in the synchronous flow
2628
- [ ] no TXT record with SPF content (i.e. `"v=spf1 ..."`) instead of using SPFM record type on APEX
@@ -31,16 +33,9 @@ Please mark the following checks done
3133
- [ ] `essential` setting is used on records, which the user shall be able to change or remove manually later without dropping the whole template (like DMARC)
3234

3335
# Example variable values
34-
<-- to make review process easier please provide example set of variable values for this template -->
35-
36-
<-- Example: -->
37-
38-
```
39-
var1: aaa
40-
var2: foo.com
41-
```
36+
<-- to make review process easier please provide example set of variable values and output for this template -->
4237

43-
<-- Or provide the whole `testData` object from the [Online Editor](https://domainconnect.paulonet.eu/dc/free/templateedit) after testing and using "Add as test" button -->
38+
<-- Example: provide the whole `testData` object from the [Online Editor](https://domainconnect.paulonet.eu/dc/free/templateedit) after testing and using "Add as test" button. Hint: test also with "host" variable set. -->
4439
```
4540
"testData": {
4641
"testset": {

0 commit comments

Comments
 (0)