Skip to content

Commit db5133d

Browse files
committed
chore: add copilot instructions to avoid commenting on generated tables
1 parent 2fcac32 commit db5133d

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

.github/copilot-instructions.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Copilot Instructions for j26-components
2+
3+
## PR Review Guidelines
4+
5+
### Component Documentation
6+
7+
When reviewing component readme.md files, **DO NOT** suggest adding comments to the props and events tables. These tables are auto-generated from the component source code and should remain comment-free to maintain consistency with the generation process.
8+
9+
Example of tables where comments should NOT be suggested:
10+
- Props tables showing component properties
11+
- Events tables documenting component events
12+
13+
The documentation for these items should be maintained in the source code itself, not in the generated tables.

0 commit comments

Comments
 (0)