Skip to content

Commit faff7a3

Browse files
author
Kevin Martin
committed
updated doc and renamed the style formats
1 parent 746602b commit faff7a3

File tree

4 files changed

+27
-6
lines changed

4 files changed

+27
-6
lines changed

Development Application Settings/Red Gate/SQL Prompt/Code Analysis Rules/CodeAnalysisSettings.casettings

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,5 +116,5 @@
116116
</IssueSettings>
117117
<UseCompression>false</UseCompression>
118118
<IssueGroups />
119-
<SettingsGuid>45f015f6-24b5-4172-b5d6-c336c21d035d</SettingsGuid>
119+
<SettingsGuid>386061d5-7081-4e64-856f-c32e5694a895</SettingsGuid>
120120
</SqlCodeGuardSettings>

README.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ The SQL Server Assess project contains the [sp_Develop](https://github.com/Emerg
33

44
This lists the database development best practice checks and naming conventions checks for the stored procedure named sp_Develop.
55

6-
## Install InstructionsEmergent Style - Collapsedf
6+
## sp_Develop Install Instructions
77

88
It is recommend installing the [sp_Develop](https://github.com/EmergentSoftware/SQL-Server-Assess/blob/master/sp_Develop.sql) stored procedures in the master database for full SQL Servers, but if you want to use another one, that's totally fine.
99

1010
On Azure SQL Server you will need to install the sp_Develop stored procedure in the user database.
1111

12-
## Usage Instructions
12+
## sp_Develop Usage Instructions
1313

1414
After installing the [sp_Develop](https://github.com/EmergentSoftware/SQL-Server-Assess/blob/master/sp_Develop.sql) stored procedure open SSMS and run in the database you wish to check for database development best practices.
1515

@@ -19,7 +19,7 @@ EXECUTE dbo.sp_Develop
1919

2020
[Check out the parameter section for more options](#Parameter-Explanations)
2121

22-
## Parameter Explanations
22+
## sp_Develop Parameter Explanations
2323

2424
|Parameter|Details|
2525
|--|--|
@@ -59,6 +59,28 @@ The 'Test Database' folder contains the RedGate SQL Source Control. Use this dat
5959
- [Link to Git](https://documentation.red-gate.com/soc7/linking-to-source-control/link-to-git)
6060

6161

62+
# Configure Development Application Settings
63+
64+
Included in this project are settings you can use for database development. Using the same set of settings across a team will helps ensure consisitent development patterns.
65+
66+
#### SQL Server Management Studio
67+
68+
The settings are located in the project "[\SQL-Server-Assess\Development Application Settings\Microsoft\SQL Server Management Studio\General Settings](https://github.com/EmergentSoftware/SQL-Server-Assess/tree/master/Development%20Application%20Settings/Microsoft/SQL%20Server%20Management%20Studio/General%20Settings)"
69+
70+
1. Cloned or forked the repo
71+
2. In SSMS navigate to "Tools > Options > Environment > Import and Export Settings"
72+
3. Check "Use team settings file" and browse to "..\SQL-Server-Assess\Development Application Settings\Microsoft\SQL Server Management Studio\General Settings\SSMS.vssettings"
73+
4. Click the "OK" button
74+
75+
#### RedGate SQL Server Prompt
76+
77+
The settings are located in the project "[\SQL-Server-Assess\Development Application Settings\Red Gate\SQL Prompt](https://github.com/EmergentSoftware/SQL-Server-Assess/tree/master/Development%20Application%20Settings/Red%20Gate/SQL%20Prompt)"
78+
79+
1. Cloned or forked the repo
80+
2. Follow [these directions](https://documentation.red-gate.com/sp/managing-sql-prompt-behavior/sharing-your-settings)
81+
82+
83+
6284
# Current High Check Id
6385

6486
## Next Check Id: 27
@@ -566,8 +588,7 @@ SELECT
566588

567589
SQL statements should be arranged in an easy-to-read manner. When statements are written all to one line or not broken into smaller easy-to-read chunks, more complicated statements are very hard to decipher.
568590

569-
Use one of the two RedGate SQL Prompt formatting styles "Collapsed" or "Expanded". If you edit T-SQL code that was in a one of the two styles, put the style back to its original style after you completed editing.
570-
591+
Use one of the two RedGate SQL Prompt formatting styles "[Team Collapsed](https://github.com/EmergentSoftware/SQL-Server-Assess/blob/master/Development%20Application%20Settings/Red%20Gate/SQL%20Prompt/Formatting%20Styles/Team%20Collapsed.sqlpromptstylev2)" or "[Team Expanded](https://github.com/EmergentSoftware/SQL-Server-Assess/blob/master/Development%20Application%20Settings/Red%20Gate/SQL%20Prompt/Formatting%20Styles/Team%20Expanded.sqlpromptstylev2)". If you edit T-SQL code that was in a one of the two styles, put the style back to its original style after you completed editing.
571592

572593

573594
## Not Using Code Comments

0 commit comments

Comments
 (0)