Skip to content

Commit f749793

Browse files
committed
docs: update changeset and pull request guidelines for clarity
- Revised content guidelines in changeset instructions to clarify that issue references do not count towards the 3-4 line summary limit. - Enhanced pull request instructions to emphasize the importance of reviewing the PR body for clarity and guidance on the changes being made. These updates aim to improve the documentation and ensure better adherence to best practices during development. Signed-off-by: Odin Thomas Rochmann <[email protected]>
1 parent 0d31799 commit f749793

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

.github/instructions/changesets.instructions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ applyTo: ".changeset/**/*.md"
1111
- **When**: Any change to a published package or `.md` docs → create a changeset (docs use `@equinor/fusion-framework-docs`).
1212
- **Type**: Feature → `minor`, bugfix → `patch`, internal refactor → `patch` with `Internal:` prefix, breaking change → `major` with migration notes.
1313
- **Format**: File in `.changeset/` named `{package-name}_{short-description}.md` with YAML frontmatter listing packages and bump types.
14-
- **Content**: Write consumer-focused summaries (3–4 lines), reference issues, include migration or code examples for complex/breaking changes.
14+
- **Content**: Write consumer-focused summaries (3–4 lines for summary content; issue references don't count), reference issues, include migration or code examples for complex/breaking changes.
1515
- **Scope**: Prefer one package per changeset; only group packages when changes and message are identical.
1616

1717
## When to Create Changesets
@@ -78,7 +78,7 @@ Fixes: https://github.com/equinor/fusion-framework/issues/123
7878
7979
**Guidelines:**
8080
- Be specific and consumer-focused
81-
- Keep under 3-4 lines
81+
- Keep summary content under 3-4 lines (issue references and contributor credits don't count toward this limit)
8282
- Include code examples for complex features
8383
- Reference issues: `Fixes #123` or `Closes #123`
8484
- Credit contributors: `Thanks @username`

.github/instructions/pull-requests.instructions.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ name: Pull Request Rules
1111
- **Template**: Always use `.github/PULL_REQUEST_TEMPLATE.md`; fill all sections, describe current vs. new behavior, and clearly call out breaking changes.
1212
- **Commits**: Use Conventional Commits for titles and commit messages (e.g. `feat(module-http): add retry logic`).
1313
- **Content**: Do not list changed files in the PR body (GitHub already shows them); focus on motivation, behavior changes, and risk/impact.
14+
- **Review**: When reviewing PRs, the PR body must be reviewed and should clearly explain what the PR does and how to review the changes.
1415

1516
## PR Creation
1617

@@ -57,6 +58,12 @@ Follow [Conventional Commits](contributing/conventional-commits.md):
5758

5859
## PR Review Process
5960

61+
### When Reviewing a PR
62+
- **Review the PR body**: The PR body content must be reviewed as part of the code review process
63+
- **Clarity check**: The PR body must clearly explain what the PR does, including current vs. new behavior
64+
- **Review guidance**: The PR body should provide clear text on how to review the changes (e.g., what to focus on, testing steps, areas of concern)
65+
- If the PR body is unclear or missing essential information, request clarification before proceeding with code review
66+
6067
### When Changes Requested
6168
- PR automatically moves to draft
6269
- Creator must address feedback
@@ -83,4 +90,10 @@ When generating PR content:
8390
- Include breaking change notes if applicable
8491
- Reference changeset if created
8592
- Follow conventional commit format for commits
93+
- Ensure the PR body clearly explains what the PR does and provides guidance on how to review the changes
94+
95+
When reviewing PRs:
96+
- Always review the PR body content as part of the review process
97+
- Verify the PR body clearly explains the change and provides review guidance
98+
- Request clarification if the PR body is unclear or missing essential information
8699

0 commit comments

Comments
 (0)