Add SQL development guidelines and best practices to instructions#49
Merged
aaronpowell merged 3 commits intogithub:mainfrom Jul 9, 2025
ambilykk:main
Merged
Add SQL development guidelines and best practices to instructions#49aaronpowell merged 3 commits intogithub:mainfrom ambilykk:main
aaronpowell merged 3 commits intogithub:mainfrom
ambilykk:main
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new Copilot instruction file for SQL development guidelines and updates the README to include it.
- Adds
instructions/sql-sp-generation.instructions.mdwith best practices for schema design, SQL coding style, stored procedures, security, and transactions - Updates
README.mdto reference the new SQL Development instructions
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| instructions/sql-sp-generation.instructions.md | New instruction file outlining SQL and SP guidelines |
| README.md | Added entry for SQL Development instructions |
Comments suppressed due to low confidence (2)
instructions/sql-sp-generation.instructions.md:64
- [nitpick] The guidelines recommend both using prepared statements for dynamic SQL and avoiding dynamic SQL in stored procedures, which conflicts. Please clarify when dynamic SQL is acceptable and adjust the wording.
- use prepared statements when executing dynamic SQL
instructions/sql-sp-generation.instructions.md:39
- Using the 'sp_' prefix can lead to lookup performance issues in some SQL engines (e.g., SQL Server searches master DB first). Consider a different naming convention to avoid that.
- prefix stored procedure names with 'sp_'
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
aaronpowell
approved these changes
Jul 9, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
node update-readme.jsand verified thatREADME.mdis up to date.Description
Add a new Copilot Instruction file with Guidelines for generating SQL statements and stored procedures. This can be used for converting ER diagrams into Schema generation scripts or can be used for generating new SQL Schema or stored procedures based on best practices.
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.