Commit 3963b43
authored
π [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
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | | - | |
| 11 | + | |
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
| 16 | + | |
16 | 17 | | |
17 | 18 | | |
18 | 19 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
103 | 103 | | |
104 | 104 | | |
105 | 105 | | |
106 | | - | |
| 106 | + | |
107 | 107 | | |
108 | 108 | | |
109 | 109 | | |
110 | 110 | | |
111 | 111 | | |
112 | | - | |
| 112 | + | |
113 | 113 | | |
114 | 114 | | |
115 | 115 | | |
| |||
155 | 155 | | |
156 | 156 | | |
157 | 157 | | |
158 | | - | |
159 | | - | |
| 158 | + | |
| 159 | + | |
160 | 160 | | |
161 | 161 | | |
162 | 162 | | |
| |||
0 commit comments