Skip to content

Commit fb40442

Browse files
authored
Merge pull request #2729 from microsoft/ci/copilot-instructions
ci: adds copilot instructions
2 parents 7c13fb3 + 754499b commit fb40442

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

.github/copilot-instructions.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Copilot Instructions
2+
3+
## Commit Message Format
4+
5+
Always use conventional commits format when creating commits. Follow this structure:
6+
7+
```
8+
<type>(<scope>): <description>
9+
10+
[optional body]
11+
12+
[optional footer(s)]
13+
```
14+
15+
### Types
16+
17+
- **feat**: A new feature
18+
- **fix**: A bug fix
19+
- **docs**: Documentation only changes
20+
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, etc)
21+
- **refactor**: A code change that neither fixes a bug nor adds a feature
22+
- **perf**: A code change that improves performance
23+
- **test**: Adding missing tests or correcting existing tests
24+
- **build**: Changes that affect the build system or external dependencies
25+
- **ci**: Changes to CI configuration files and scripts
26+
- **chore**: Other changes that don't modify src or test files
27+
28+
### Scope
29+
30+
The scope should indicate the package or area affected (e.g., `library`, `yaml-reader`, `hidi`).
31+
32+
### Examples
33+
34+
```
35+
feat(library): add support for pattern properties
36+
fix(yaml-reader): updates boolean serialization
37+
docs(README): update installation instructions
38+
ci(release): configure automated release workflow
39+
```
40+
41+
### Breaking Changes
42+
43+
If a commit introduces a breaking change, add `BREAKING CHANGE:` in the footer or append `!` after the type/scope:
44+
45+
```
46+
feat(identity-emitter)!: change output format for models
47+
48+
BREAKING CHANGE: The emitter now generates TypeScript interfaces instead of types
49+
```
50+
51+
52+
## Updating the benchmark information
53+
54+
The user might request you update the benchmark information. You might do it on your own if a previous change added new properties to models under **src/Microsoft.OpenApi/Models**. Always use a separate commit for this change.
55+
56+
To do so, run the following script:
57+
58+
```shell
59+
cd performance/benchmark
60+
dotnet run -c Release
61+
```
62+
63+
Then commit the report files using a "chore" commit.

0 commit comments

Comments
 (0)