feat(instructions): add Salesforce LWC development instructions #530
+427
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive development instructions for Salesforce Lightning Web Components (LWC) to help GitHub Copilot provide better assistance when working with LWC projects. The instructions cover component structure, SLDS design system usage, reactive properties, wire services, error handling, and common anti-patterns to avoid.
Key Changes
- Added new instruction file
lwc.instructions.mdwith LWC-specific development guidelines - Updated
docs/README.instructions.mdto include the new LWC instruction in the alphabetically sorted table
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| instructions/lwc.instructions.md | New instruction file providing comprehensive guidelines for LWC development including component architecture, SLDS compliance, performance optimization, and accessibility best practices |
| docs/README.instructions.md | Added LWC Development entry to the instructions table with appropriate install badges and description |
Co-authored-by: Copilot <[email protected]>
…esome-copilot into add-lws-instructions
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Checklist
npm startand verified thatREADME.mdis up to date.Description
This PR adds a new instruction file, lwc.instructions.md, focused on Salesforce Lightning Web Components (LWC) development.
It provides Copilot with specific context on Salesforce platform constraints, security models, and design systems. The file is structured to have the "Positive/Negative" constraints and "Good/Bad" code examples to steer the model away from common anti-patterns (like direct DOM manipulation or imperative Apex) and towards standard practices (Wire Service, LDS, SLDS).
Type of Contribution
Additional Notes
By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.