Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/docs/Ways-of-Working/Commit-Conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Commit messages serve two audiences: the engineer reading `git log` six months f
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.
3. **No generic messages.** `Update for PR`, `WIP`, `fixes`, `more changes` β€” all forbidden. They erase traceability.
4. **One logical change per commit.** Micro-iterative discipline. If a change touches three unrelated concerns, that's three commits.
5. **Reference issues by number when natural** β€” but don't force it. `Fixes #N` belongs in the PR description, not every commit message.
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.

## Examples

Expand Down
1 change: 1 addition & 0 deletions src/docs/Ways-of-Working/Issue-Format.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Every issue in the PSModule organization follows the same structure. The format
- **Comments record change history only.** Each description update is accompanied by a comment summarizing what changed and why.
- **Tone is impersonal.** No first-person ("I", "my") or second-person ("you", "your") language. Neutral references like "the user", "the developer", or passive constructions.
- **External references are hyperlinks.** Every mention of an API, RFC, library, doc, or tool is a clickable `[text](url)` link. No bare URLs.
- **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`).
- **No duplicates.** Existing issues are searched before creating or restructuring. Duplicates are consolidated or cross-linked.

## Title
Expand Down
8 changes: 4 additions & 4 deletions src/docs/Ways-of-Working/PR-Format.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,13 +103,13 @@ Omit the section entirely if there's nothing noteworthy.

### 4. Related issues

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.
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`).

```markdown
<details>
<summary>Related issues</summary>

- Fixes PSModule/GitHub#123
- Fixes #123
- PSModule/Process-PSModule#124

</details>
Expand Down Expand Up @@ -155,8 +155,8 @@ Commands that query a specific repository, enterprise, or release by name now re
<details>
<summary>Related issues</summary>

- Fixes PSModule/GitHub#218
- PSModule/GitHub#219
- Fixes #218
- #219

</details>
````
Expand Down