Skip to content

Commit ecd3695

Browse files
committed
chore: update commit message guidelines for clarity
1 parent 75205c0 commit ecd3695

File tree

2 files changed

+15
-17
lines changed

2 files changed

+15
-17
lines changed

.github/CONTRIBUTING.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -81,18 +81,15 @@ src/
8181

8282
We follow [Conventional Commits](https://www.conventionalcommits.org/) to automate our release process. We use `husky` and `commitlint` to enforce this standard locally.
8383

84-
**Format**: `type(scope): description`
85-
86-
- `feat`: New features (triggers a minor version bump)
87-
- `fix`: Bug fixes (triggers a patch version bump)
88-
- `docs`: Documentation changes
89-
- `test`: Test additions/changes
90-
- `refactor`: Code refactoring
91-
- `chore`: Maintenance tasks
92-
93-
**Examples**:
94-
- `feat: add auto-detection of PHPStan config files`
95-
- `fix: resolve crash when parsing error output`
84+
Release Please assumes you are using Conventional Commit messages.
85+
86+
The most important prefixes you should have in mind are:
87+
88+
- `fix`: which represents bug fixes, and correlates to a SemVer patch.
89+
- `feat`: which represents a new feature, and correlates to a SemVer minor.
90+
- `feat!`: or `fix!:`, `refactor!:`, etc., which represent a breaking change (indicated by the `!`) and will result in a SemVer major.
91+
92+
For a full list of types and rules, please visit [conventionalcommits.org](https://www.conventionalcommits.org/).
9693

9794
## Pull Request Process
9895

.github/copilot-instructions.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,12 @@ This project is a VS Code extension that integrates PHPStan (Static Analysis) ru
5757
- Provide "Quick Fixes" or buttons in error messages for common actions (like "Start DDEV").
5858

5959
5. **Commit Messages**:
60-
- STRICTLY follow Conventional Commits format: `type(scope): description`.
61-
- Allowed types: `feat`, `fix`, `docs`, `test`, `refactor`, `chore`.
62-
- Examples:
63-
- `feat: add new setting`
64-
- `fix: resolve crash`
60+
- STRICTLY follow [Conventional Commits](https://www.conventionalcommits.org/) format: `type(scope): description`.
61+
- Release Please assumes you are using Conventional Commit messages.
62+
- Most important prefixes:
63+
- `fix`: bug fixes (SemVer patch).
64+
- `feat`: new features (SemVer minor).
65+
- `feat!`, `fix!`, `refactor!`: breaking changes (SemVer major).
6566

6667
## Common Tasks
6768

0 commit comments

Comments
 (0)