Skip to content

📖 [Docs]: Scope issue and PR references by repository (local, remote, external)#50

Merged
Marius Storhaug (MariusStorhaug) merged 5 commits into
mainfrom
docs/49-fully-qualified-references
Jul 1, 2026
Merged

📖 [Docs]: Scope issue and PR references by repository (local, remote, external)#50
Marius Storhaug (MariusStorhaug) merged 5 commits into
mainfrom
docs/49-fully-qualified-references

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Jul 1, 2026

Copy link
Copy Markdown
Member

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 Scope issue and PR references to the target repository #49 completed.
Related issues

@MariusStorhaug Marius Storhaug (MariusStorhaug) changed the title 📖 [Docs]: Ways of Working now require fully qualified issue and PR references 📖 [Docs]: Scope issue and PR references by repository (local, remote, external) Jul 1, 2026
@MariusStorhaug

Copy link
Copy Markdown
Member Author

CI note — the failing Lint check is pre-existing and unrelated to this change.

super-linter validates the entire codebase, and main is already red: commit 99d9d5a introduced MD060/table-column-style violations in continuous-x-and-continuous-ai.md, devops-reference.md, and development-practices.md (the markdownlint config at .github/linters/.markdown-lint.yml does not disable MD060).

None of the three files changed here — Issue-Format.md, PR-Format.md, Commit-Conventions.md — are flagged. Build, CodeQL, and both Analyze checks pass.

Making main green again (either reformatting the offending tables or adding MD060: false to .github/linters/.markdown-lint.yml) is a separate change and intentionally out of scope here.

@MariusStorhaug

Copy link
Copy Markdown
Member Author

Tracked separately in #51.

@MariusStorhaug Marius Storhaug (MariusStorhaug) marked this pull request as ready for review July 1, 2026 09:58
@MariusStorhaug Marius Storhaug (MariusStorhaug) force-pushed the docs/49-fully-qualified-references branch from 3db54e6 to 99fba6d Compare July 1, 2026 10:40
@MariusStorhaug Marius Storhaug (MariusStorhaug) merged commit 3963b43 into main Jul 1, 2026
21 checks passed
@MariusStorhaug Marius Storhaug (MariusStorhaug) deleted the docs/49-fully-qualified-references branch July 1, 2026 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Scope issue and PR references to the target repository

1 participant