You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-27Lines changed: 8 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,24 +76,14 @@ You can optionally open a **Draft Pull Request** earlier during development to g
76
76
77
77
---
78
78
79
-
## Commit Message Convention
80
-
81
-
This project follows [Conventional Commits](https://www.conventionalcommits.org/). Every commit message must start with a **type prefix**, followed by a short description written as a **verb phrase starting with a capital letter**.
82
-
83
-
```
84
-
<type>: <Verb> <subject>
85
-
```
79
+
## Pull Request Guidelines
86
80
87
-
**Examples:**
88
-
```
89
-
feat: Add searchbar component
90
-
fix: Resolve crash when schema is empty
91
-
refactor: Extract validation logic into utility
92
-
docs: Update contributing guide
93
-
chore: Bump version to 2.1.0
94
-
```
81
+
-**Title:** Must follow the [Conventional Commits](https://www.conventionalcommits.org/) format — `<type>: <Verb> <subject>` — e.g. `feat: Add searchbar component`. This is required because the PR title is used as the squash merge commit message on `main`, from which the CI/CD pipeline automatically determines the semantic version bump and creates a release tag.
82
+
-**Description:** Always explain **why** the change is needed, not just what was changed. Link the related issue.
83
+
-**Scope:** Keep PRs focused on a single concern. Smaller PRs are reviewed faster and merged sooner.
84
+
-**Discussion:** PRs are the primary place for code review discussion. Use inline comments and the general PR thread to ask questions and suggest improvements.
95
85
96
-
**Type prefixes and their effect on versioning:**
86
+
**PR title type prefixes and their effect on versioning:**
|`BREAKING CHANGE:`| Incompatible API change | Major (`X.0.0`) |
108
-
109
-
The CI/CD pipeline uses these prefixes to automatically determine the next [semantic version](https://semver.org/) when commits are merged to `main`.
97
+
|`breaking:`| Incompatible API change | Major (`X.0.0`) |
110
98
111
-
---
112
-
113
-
## Pull Request Guidelines
114
-
115
-
-**Title:** Use the same convention as commit messages — `<type>: <Verb> <subject>`.
116
-
-**Description:** Always explain **why** the change is needed, not just what was changed. Link the related issue.
117
-
-**Scope:** Keep PRs focused on a single concern. Smaller PRs are reviewed faster and merged sooner.
118
-
-**Discussion:** PRs are the primary place for code review discussion. Use inline comments and the general PR thread to ask questions and suggest improvements.
99
+
PRs are always merged via **squash merge**, so the PR title becomes the single commit message on `main`. Individual commit messages on your branch are not required to follow the Conventional Commits format, but should still start with a verb and clearly describe what was done, e.g. `Add validation for empty schema` — this helps reviewers follow your work in the PR.
0 commit comments