Skip to content

Commit 57eddc9

Browse files
Add full-URL guidance and fully qualified example to PR Format
1 parent 80f3ce2 commit 57eddc9

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

src/docs/Ways-of-Working/PR-Format.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Omit the section entirely if there's nothing noteworthy.
103103

104104
### 4. Related issues
105105

106-
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+
A collapsible `<details>` block at the very end of the description containing issue links. Always use fully qualified references (`Owner/Repo#N`, for example `PSModule/GitHub#123`) — never the bare `#123` shorthand — so links resolve unambiguously across repositories and in release notes. When a reference appears outside GitHub (release announcements, Jira, Slack, external docs), use the full URL (`https://github.com/PSModule/GitHub/issues/123`).
107107

108108
```markdown
109109
<details>
@@ -150,7 +150,7 @@ Commands that query a specific repository, enterprise, or release by name now re
150150
- `GitHubRepository` class: `CustomProperties` property changed from `[PSCustomObject]` to `[GitHubCustomProperty[]]`.
151151
- `Invoke-GitHubGraphQLQuery`: error handling split into partial-success (data + errors → warnings) and full-failure (errors only → terminating error) branches.
152152
- Null guards added to `Get-GitHubRepositoryByName`, `Get-GitHubMyRepositoryByName`, and related functions.
153-
- Implementation plan progress: tasks 1–3 in #218 completed; task 4 (integration tests) remains.
153+
- Implementation plan progress: tasks 1–3 in PSModule/GitHub#218 completed; task 4 (integration tests) remains.
154154

155155
<details>
156156
<summary>Related issues</summary>

0 commit comments

Comments
 (0)