-
Notifications
You must be signed in to change notification settings - Fork 16
Add copilot instructions #3387
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Add copilot instructions #3387
Conversation
Documentation has been published to https://lundalogik.github.io/lime-elements/versions/PR-3387/ |
}) | ||
export class ExampleComponent { | ||
// 1) Public Props | ||
@Prop() label: string; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't quite follow the format we use.
@Prop() label: string; | |
@Prop() | |
public label: string; |
// 2) Event Props | ||
@Event() labelChanged: EventEmitter<string>; | ||
|
||
// 3) Element Reference | ||
@Element() hostElement: HTMLElement; | ||
|
||
// 4) State | ||
@State() isOpen: boolean = false; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
// 2) Event Props | |
@Event() labelChanged: EventEmitter<string>; | |
// 3) Element Reference | |
@Element() hostElement: HTMLElement; | |
// 4) State | |
@State() isOpen: boolean = false; | |
// 2) Event Props | |
@Event() | |
public labelChanged: EventEmitter<string>; | |
// 3) Element Reference | |
@Element() | |
private host: HTMLElement; | |
// 4) State | |
@State() | |
private isOpen: boolean = false; |
197298f
to
a0e1088
Compare
4688a72
to
ca99ebe
Compare
WalkthroughThe pull request introduces a new markdown file that provides comprehensive guidelines for developers working on a TypeScript project using Stencil v2. The document details a recommended "Newspaper code structure" for organizing component code and outlines various practices related to project setup, dependency management, testing, and documentation. Additionally, the Changes
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 4
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
.github/copilot-instructions.md
(1 hunks).gitignore
(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
.github/copilot-instructions.md
1-1: First line in a file should be a top-level heading
null
(MD041, first-line-heading, first-line-h1)
2-2: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
10-10: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
28-28: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Test
- GitHub Check: Build
🔇 Additional comments (1)
.github/copilot-instructions.md (1)
45-92
: Positive Feedback: Detailed Component Example
The embedded code example clearly demonstrates the “Newspaper code structure” for component organization. It serves as an excellent reference for developers by explicitly outlining the order of properties and methods.
.env | ||
venv/ | ||
|
||
copilot-instructions.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧹 Nitpick (assertive)
Clarification on Ignore Pattern: Specify the Target Path
The new entry "copilot-instructions.md"
will ignore any file with that name in any directory. If your intent is to ignore only the guidelines file located in the .github
directory, consider updating the pattern to .github/copilot-instructions.md
to prevent inadvertently ignoring similarly named files elsewhere.
@@ -0,0 +1,137 @@ | |||
**Context**: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧹 Nitpick (assertive)
Markdown Styling Improvement: Add a Top-Level Heading
To comply with markdownlint's MD041 rule, consider adding a top-level heading (e.g., # Copilot Instructions
) as the very first line of the document. This will help signal the document's primary purpose immediately.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
1-1: First line in a file should be a top-level heading
null
(MD041, first-line-heading, first-line-h1)
|
||
#### **Property Structure** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧹 Nitpick (assertive)
Markdown Formatting: Surround Headings with Blank Lines
For better readability and to adhere to markdownlint (MD022) guidelines, please insert blank lines before and after headings such as the one on line 10 (#### **Property Structure**
).
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
10-10: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
--- | ||
|
||
**Requirements for Responses**: | ||
|
||
1. **Code Structure** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧹 Nitpick (assertive)
Enhancement Suggestion: Add a Table of Contents
Given the comprehensive nature of these guidelines, adding a table of contents at the beginning could significantly improve navigability for developers.
Fixes: https://github.com/Lundalogik/crm-feature/issues/4542
Summary by CodeRabbit