You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
π [Docs]: PR descriptions now require standardized ending blocks (#95)
PR description guidance now requires a consistent ending section that
matches the standard currently used in PSModule/Domeneshop. Contributors
now get explicit, copy-pasteable structure for the separator line plus
both foldable blocks with exact summary text.
## Changed: PR ending structure is now explicitly required
The PR format standard now requires all PR descriptions to end with a
horizontal separator and two `<details>` blocks, in a fixed order and
with exact summary text.
---
<details>
<summary>Technical details</summary>
- Updated `Ways-of-Working/PR-Format` to require the exact
end-of-description structure.
- Replaced prior "Technical Details" heading guidance with required
foldable block guidance.
- Updated the example snippet to use `Technical details` and `Relevant
issues (or links)` exactly.
</details>
<details>
<summary>Relevant issues (or links)</summary>
- PSModule/Domeneshop#16
</details>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copy file name to clipboardExpand all lines: src/docs/Ways-of-Working/PR-Format.md
+25-19Lines changed: 25 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,36 +92,38 @@ Under each header:
92
92
93
93
Do **not** mention internal function names, class names, private APIs, or refactoring decisions here.
94
94
95
-
### 3. Technical details (optional)
95
+
### 3. Required ending blocks
96
96
97
-
```markdown
98
-
## Technical Details
99
-
```
100
-
101
-
For reviewers and maintainers. Not part of the release note. Include:
102
-
103
-
- Which internal functions, classes, or files were changed.
104
-
- Implementation approach and design decisions.
105
-
- Backward compatibility notes for developers.
106
-
-**Implementation plan progress** β cross-reference Section 3 of the linked issue. Which tasks does this PR complete? Which remain?
97
+
At the very end of every PR description, use this exact structure:
107
98
108
-
Omit the section entirely if there's nothing noteworthy.
99
+
```markdown
100
+
---
101
+
<details>
102
+
<summary>Technical details</summary>
109
103
110
-
### 4. Related issues
104
+
...
111
105
112
-
A collapsible `<details>` block at the very end of the description containing issue links. Always use fully qualified references (`Owner/Repo#N`) so links work across repositories.
106
+
</details>
113
107
114
-
```markdown
115
108
<details>
116
-
<summary>Related issues</summary>
109
+
<summary>Relevant issues (or links)</summary>
117
110
118
111
- Fixes Owner/Repo#123
119
112
-Owner/OtherRepo#124
120
113
121
114
</details>
122
115
```
123
116
124
-
One bullet per linked issue. Use a [closing keyword](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue) (`Fixes`, `Closes`, `Resolves`) when the PR fully addresses the issue. Otherwise, list the reference without a keyword to indicate a relationship without auto-closing.
117
+
The **Technical details** block is for reviewers and maintainers. Include internal implementation notes such as:
118
+
119
+
- Which internal functions, classes, or files were changed.
120
+
- Implementation approach and design decisions.
121
+
- Backward compatibility notes for developers.
122
+
-**Implementation plan progress** β cross-reference Section 3 of the linked issue. Which tasks does this PR complete? Which remain?
123
+
124
+
The **Relevant issues (or links)** block is required and uses fully qualified references (`Owner/Repo#N`) so links work across repositories.
125
+
126
+
Use one bullet per linked issue. Use a [closing keyword](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue) (`Fixes`, `Closes`, `Resolves`) when the PR fully addresses the issue. Otherwise, list the reference without a keyword to indicate a relationship without auto-closing.
125
127
126
128
If no issue is linked: **stop**. PRs without issues break the workflow. Route back to the Ideator role or proceed only on explicit user confirmation. The Shipper enforces this.
127
129
@@ -150,15 +152,19 @@ The `repo properties` command remains available if only the properties are neede
150
152
151
153
Commands that query a specific repository, enterprise, or release by name now return nothing instead of throwing when the resource doesn't exist. This makes them safe to use in conditional logic without error handling.
152
154
153
-
## Technical Details
155
+
---
156
+
<details>
157
+
<summary>Technical details</summary>
154
158
155
159
- The repository model's custom-properties field is now a typed collection rather than an untyped object.
156
160
- The GraphQL query layer splits error handling into partial-success (data + errors β warnings) and full-failure (errors only β terminating error) branches.
157
161
- Null guards added to the repository lookup helpers.
158
162
- Implementation plan progress: tasks 1β3 in #218 completed; task 4 (integration tests) remains.
0 commit comments