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
+65Lines changed: 65 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,71 @@ We appreciate your interest in contributing to MageForge! Please follow the guid
11
11
12
12
---
13
13
14
+
## Commit Message Guidelines
15
+
16
+
We use [Conventional Commits](https://www.conventionalcommits.org/) for automated changelog generation and semantic versioning via [Release Please](https://github.com/googleapis/release-please).
17
+
18
+
### For Contributors (Pull Requests)
19
+
20
+
**PR Title Format** (Required): Your PR title **must** follow Conventional Commits format:
21
+
22
+
```
23
+
<type>: <description>
24
+
25
+
Examples:
26
+
✅ feat: add Hyvä compatibility check command
27
+
✅ fix: resolve npm installation issue
28
+
✅ docs: update README with new examples
29
+
✅ refactor: simplify theme builder logic
30
+
✅ perf: optimize static file cleaning
31
+
32
+
❌ Add new feature (missing type)
33
+
❌ Fixed bug (missing colon)
34
+
```
35
+
36
+
**Commit Types**:
37
+
-`feat:` - New feature (minor version bump: 0.3.0 → 0.4.0)
38
+
-`fix:` - Bug fix (patch version bump: 0.3.0 → 0.3.1)
39
+
-`refactor:` - Code refactoring (no version bump by default)
40
+
-`docs:` - Documentation updates (patch version bump)
41
+
-`perf:` - Performance improvements (patch version bump)
42
+
-`style:` - Code style changes (no version bump)
43
+
-`test:` - Test updates (no version bump)
44
+
-`chore:` - Maintenance tasks (no version bump)
45
+
46
+
**Breaking Changes**: Add `!` after the type for major version bumps:
47
+
```
48
+
feat!: remove legacy theme builder API
49
+
fix!: change command argument order
50
+
```
51
+
52
+
**Individual Commits**: Your individual commits within the PR can use any format you prefer. We use **squash-merge**, so only the PR title becomes the commit message in the `main` branch.
53
+
54
+
### For Maintainers (Direct Commits)
55
+
56
+
When committing directly to `main` (e.g., hotfixes, urgent documentation updates), **all commits must follow Conventional Commits format**:
MageForge is a powerful CLI front-end development toolkit for Magento 2 that simplifies theme development workflows. It provides tools for many types of Magento themes and can be easily extended for your custom theme. With MageForge, themes can be built lightning fast, without your developers having to worry about the details. MageForge eliminates complex configuration requirements and significantly reduces setup time, allowing Magento developers to focus on creative aspects instead of struggling with build processes.
0 commit comments