Skip to content

Commit 3b53fc3

Browse files
committed
chore: add commit guidelines
1 parent 303de60 commit 3b53fc3

2 files changed

Lines changed: 56 additions & 9 deletions

File tree

.gemini/styleguide.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,34 @@
22

33
Use this style guide when reviewing pull requests for additional checks. These checks are in addition to the standard code review guidelines and are focused on ensuring that changes are properly documented, accessible, and aligned with release management practices.
44

5+
## Pull Request title and description
6+
7+
## Title
8+
9+
Follow the rule `<type>[optional <scope>]: <description>`
10+
11+
Examples are:
12+
13+
- `fix(core): correct button color in dark theme`
14+
- `feat(core/select): add feature X to component select`
15+
16+
### Commit message with ! to draw attention to breaking change
17+
18+
- `feat!: correct button color in dark theme`
19+
- `feat(core/select)!: add feature X to component select`
20+
21+
### Allowed types without scope
22+
23+
- `chore`
24+
- `docs`
25+
- `refactor`
26+
- `test`
27+
28+
## Description
29+
30+
- Check that the pull request description explains the user-facing impact, motivation, and important implementation details.
31+
- If the description is insufficient for reviewers or future maintainers to understand the effect of the change, request that it be expanded.
32+
533
## Changesets
634

735
- Treat a missing changeset as a review issue when a pull request includes user-facing or consumer-relevant changes.
@@ -26,11 +54,6 @@ Use this style guide when reviewing pull requests for additional checks. These c
2654

2755
- Check that the pull request description or commit message includes a GitHub issue reference or Jira reference matching `IX-<issue-number>` when the work is tied to a tracked requirement.
2856

29-
## Pull Request Description
30-
31-
- Check that the pull request description explains the user-facing impact, motivation, and important implementation details.
32-
- If the description is insufficient for reviewers or future maintainers to understand the effect of the change, request that it be expanded.
33-
3457
## Review Priorities
3558

3659
- Focus first on correctness, regressions, accessibility, release impact, and missing validation.

.github/instructions/code-review.instructions.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,34 @@ excludeAgent: 'cloud-agent'
55

66
# GitHub Copilot Code Review Rules
77

8+
## Pull Request title and description
9+
10+
## Title
11+
12+
Follow the rule `<type>[optional <scope>]: <description>`
13+
14+
Examples are:
15+
16+
- `fix(core): correct button color in dark theme`
17+
- `feat(core/select): add feature X to component select`
18+
19+
### Commit message with ! to draw attention to breaking change
20+
21+
- `feat!: correct button color in dark theme`
22+
- `feat(core/select)!: add feature X to component select`
23+
24+
### Allowed types without scope
25+
26+
- `chore`
27+
- `docs`
28+
- `refactor`
29+
- `test`
30+
31+
## Description
32+
33+
- Check that the pull request description explains the user-facing impact, motivation, and important implementation details.
34+
- If the description is insufficient for reviewers or future maintainers to understand the effect of the change, request that it be expanded.
35+
836
## Changesets
937

1038
- Treat a missing changeset as a review issue when a pull request includes user-facing or consumer-relevant changes.
@@ -45,7 +73,3 @@ regressionTest('accessibility', async ({ mount, makeAxeBuilder }) => {
4573
## Requirement linking
4674

4775
- Ensure that GitHub issue or Jira link (pattern `IX-<issue-number>`) is included in the pull request description or commit message.
48-
49-
## PR description
50-
51-
- Ensure that the pull request description clearly explains the user-facing impact of the change, including any relevant context, motivation, and details about the change. If the description is insufficient, request that the author expand it to provide a clear understanding of the change for reviewers and future maintainers.

0 commit comments

Comments
 (0)