Skip to content

Commit c0f811d

Browse files
committed
docs: add Git commit guidelines and examples to copilot instructions
1 parent 88d52f4 commit c0f811d

1 file changed

Lines changed: 46 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,3 +104,49 @@ Use `mcp_nuxt-ui_get-component` or `mcp_nuxt-ui_get-component-metadata` to find:
104104
- Available slots for customization
105105
- The `ui` prop structure with all customizable slots
106106
- Theme configuration in `app.config.ts`
107+
108+
## Git Commit Guidelines
109+
110+
This project uses **Conventional Commits** for all commit messages.
111+
112+
### Commit Message Format
113+
```
114+
<type>(<scope>): <description>
115+
116+
[optional body]
117+
118+
[optional footer(s)]
119+
```
120+
121+
### Types
122+
- **feat**: A new feature
123+
- **fix**: A bug fix
124+
- **docs**: Documentation only changes
125+
- **style**: Changes that do not affect the meaning of the code (white-space, formatting)
126+
- **refactor**: A code change that neither fixes a bug nor adds a feature
127+
- **perf**: A code change that improves performance
128+
- **test**: Adding missing tests or correcting existing tests
129+
- **chore**: Changes to the build process or auxiliary tools and libraries
130+
- **ci**: Changes to CI configuration files and scripts
131+
132+
### Scope (optional)
133+
Use the scope to specify the area of the codebase affected:
134+
- `content` - Blog posts and content files
135+
- `ui` - UI components and styling
136+
- `config` - Configuration files (nuxt.config.ts, app.config.ts)
137+
- `deps` - Dependency updates
138+
139+
### Examples
140+
```
141+
feat(content): add new blog post about TypeScript tips
142+
fix(ui): correct navigation menu alignment on mobile
143+
docs: update README with deployment instructions
144+
chore(deps): update nuxt to v4.1.0
145+
refactor(ui): simplify AppHeader component structure
146+
```
147+
148+
### Rules
149+
- Use lowercase for the type and description
150+
- Do not end the description with a period
151+
- Use imperative mood in the description ("add" not "added" or "adds")
152+
- Keep the first line under 72 characters

0 commit comments

Comments
 (0)