Skip to content

Commit d2c061c

Browse files
committed
docs(copilot): add commit message guidelines
Added guidelines for writing commit messages following the conventional commits format to ensure consistency and clarity in the repository. - Included instructions on the format: `<type>(<scope>): <description>` - Provided examples for both feature and fix commit messages - Emphasized the importance of present tense and detailed descriptions
1 parent ad71161 commit d2c061c

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Copilot Instructions
2+
3+
## Commit Messages
4+
5+
- Use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) message format. Format: `<type>(<scope>): <description>`
6+
- Include scope in the title.
7+
- The subject should be in present tense describing the overall changes as a completed action.
8+
- The next paragraph should be an overall description of the changes.
9+
- Subsequent lines should be a bulleted list of the changes.
10+
11+
Example 1:
12+
13+
```
14+
feat(services): add new user registration endpoint
15+
16+
Added a new API endpoint for user registration that accepts email and password, creates a new user in the database, and returns a JWT token.
17+
18+
- Created `RegisterUserCommand` and corresponding handler in `GreenField.Services`
19+
- Added `POST /api/register` endpoint in `API/Controllers/AuthController.cs`
20+
- Updated database schema with new `Users` table via Inflatable mapping
21+
```
22+
23+
Example 2:
24+
25+
```
26+
fix(frontend): resolve issue with theme variable loading
27+
28+
Fixed a bug where theme CSS variables were not loading correctly on initial page load, causing the default theme to be applied instead of the user's selected theme.
29+
30+
- Updated `ThemeService` to ensure CSS variables are applied before the first render
31+
- Added unit tests for `ThemeService` to verify correct variable application
32+
```

0 commit comments

Comments
 (0)