Skip to content

Commit f0ad203

Browse files
committed
docs: add conventional commits guidelines to copilot instructions
1 parent 231a31a commit f0ad203

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,30 @@ func UserValidate(obj *User) []error {
111111
- **Internal errors**: Return standard Go errors for development issues
112112
- **Fatal errors**: Use `log.Fatal()` only in main package for CLI errors
113113

114+
### Commit Message Conventions
115+
Follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) pattern for all commit messages:
116+
117+
**Format**: `<type>[optional scope]: <description>`
118+
119+
**Types**:
120+
- `feat` - New features or functionality
121+
- `fix` - Bug fixes
122+
- `docs` - Documentation changes
123+
- `style` - Code style/formatting changes (no logic changes)
124+
- `refactor` - Code refactoring without feature/bug changes
125+
- `test` - Adding or updating tests
126+
- `perf` - Performance improvements
127+
- `build` - Build system or dependency changes
128+
- `ci` - CI/CD configuration changes
129+
- `chore` - Maintenance tasks
130+
131+
**Examples**:
132+
- `feat: add support for email validation tag`
133+
- `fix: handle empty strings in min/max validation`
134+
- `docs: update README with new validation examples`
135+
- `test: add benchmark tests for string validations`
136+
- `refactor(parser): simplify validation tag parsing logic`
137+
114138
## Best Practices for Contributors
115139

116140
### Code Generation

0 commit comments

Comments
 (0)