Skip to content

Commit 3963b43

Browse files
πŸ“– [Docs]: Scope issue and PR references by repository (local, remote, external) (#50)
The Ways of Working now explain where issue and pull request references belong, and how to format them. References live in issues and pull requests β€” not in commit messages β€” and are scoped to where they resolve. ## Changed: How issues, PRs, and commits reference each other - **Same repository** β€” use the `#123` shorthand. - **Another repository** β€” use the fully qualified `Owner/Repo#123` form so the link resolves to the right repository. - **Outside GitHub** (Jira, Confluence, Slack, external docs, release announcements) β€” use the full URL, since no GitHub autolinking applies. - **Commit messages** β€” carry no issue or PR references at all. The pull request links the work to its issue (via a closing keyword such as `Fixes #123`); commits describe the change itself. Updated documents: - **Issue Format** gains a "Properties of every issue" rule covering the same-repo, cross-repo, and external cases. - **PR Format** scopes the Related issues rule the same way, and its examples now model both forms β€” a same-repo `Fixes #123` alongside a cross-repo `PSModule/Process-PSModule#124`. - **Commit Conventions** rule 5 now keeps issue and PR references out of commit history entirely. ## Technical Details - `src/docs/Ways-of-Working/Issue-Format.md`: new bullet under "Properties of every issue". - `src/docs/Ways-of-Working/PR-Format.md`: Β§4 Related issues rule reworded; same-repo examples use `#123`/`#218`/`#219`, the cross-repo example keeps `Owner/Repo#N`. - `src/docs/Ways-of-Working/Commit-Conventions.md`: rule 5 changed from "reference issues" to "keep issue and PR references out of commit messages". - Implementation plan progress: all three tasks in #49 completed. <details> <summary>Related issues</summary> - Fixes #49 </details>
1 parent 43397c8 commit 3963b43

3 files changed

Lines changed: 6 additions & 5 deletions

File tree

β€Žsrc/docs/Ways-of-Working/Commit-Conventions.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Commit messages serve two audiences: the engineer reading `git log` six months f
88
2. **No conventional-commit prefixes.** No `fix:`, `feat:`, `docs:`, `chore:`, `refactor:`, etc. The change type is captured at the PR level β€” repeating it on every commit adds noise without information.
99
3. **No generic messages.** `Update for PR`, `WIP`, `fixes`, `more changes` β€” all forbidden. They erase traceability.
1010
4. **One logical change per commit.** Micro-iterative discipline. If a change touches three unrelated concerns, that's three commits.
11-
5. **Reference issues by number when natural** β€” but don't force it. `Fixes #N` belongs in the PR description, not every commit message.
11+
5. **Keep issue and pull request references out of commit messages.** Cross-references to issues and pull requests belong in the PR description and in issues β€” not in commit history. The pull request links the work to its issue (via a closing keyword such as `Fixes #123`); commits describe the change itself.
1212

1313
## Examples
1414

β€Žsrc/docs/Ways-of-Working/Issue-Format.mdβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Every issue in the PSModule organization follows the same structure. The format
1313
- **Comments record change history only.** Each description update is accompanied by a comment summarizing what changed and why.
1414
- **Tone is impersonal.** No first-person ("I", "my") or second-person ("you", "your") language. Neutral references like "the user", "the developer", or passive constructions.
1515
- **External references are hyperlinks.** Every mention of an API, RFC, library, doc, or tool is a clickable `[text](url)` link. No bare URLs.
16+
- **Issue and PR references are scoped to their target.** Use the `#123` shorthand for an issue or pull request in the same repository, and the fully qualified `Owner/Repo#123` form for one in another repository so the link resolves to the right place. Outside GitHub β€” Jira, Confluence, Slack, or any surface without GitHub autolinking β€” use the full URL (`https://github.com/Owner/Repo/issues/123`).
1617
- **No duplicates.** Existing issues are searched before creating or restructuring. Duplicates are consolidated or cross-linked.
1718

1819
## Title

β€Žsrc/docs/Ways-of-Working/PR-Format.mdβ€Ž

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -103,13 +103,13 @@ 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. Use the `#123` shorthand for issues in the same repository and the fully qualified `Owner/Repo#123` form for issues in another repository so links resolve to the right place. When a reference appears outside GitHub (release announcements, Jira, Slack, external docs), use the full URL (`https://github.com/Owner/Repo/issues/123`).
107107

108108
```markdown
109109
<details>
110110
<summary>Related issues</summary>
111111

112-
- Fixes PSModule/GitHub#123
112+
- Fixes #123
113113
- PSModule/Process-PSModule#124
114114

115115
</details>
@@ -155,8 +155,8 @@ Commands that query a specific repository, enterprise, or release by name now re
155155
<details>
156156
<summary>Related issues</summary>
157157

158-
- Fixes PSModule/GitHub#218
159-
- PSModule/GitHub#219
158+
- Fixes #218
159+
- #219
160160

161161
</details>
162162
````

0 commit comments

Comments
Β (0)