You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**Do you want to request a *feature* or report a *bug*?**
2
+
If you're reporting a bug, include the version number of the script you're using. If it's not the current version, upgrade to the current version and test that before reporting a bug - we fix a lot of stuff in each new build.
3
+
4
+
**What is the current behavior?**
5
+
6
+
**If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via http://sqlfiddle.com**
7
+
8
+
**What is the expected behavior?**
9
+
10
+
**Which versions of SQL Server and which OS are affected by this issue? Did this work in previous versions of our procedures?**
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+62-5Lines changed: 62 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,14 +7,15 @@ First of all, welcome! We're excited that you'd like to contribute. How would yo
7
7
*[I'd like to fix bugs in T-SQL checks](#how-to-fix-bugs-in-existing-t-sql-checks)
8
8
*[I'd like to test checks written by someone else](#how-to-test-checks-written-by-someone-else)
9
9
*[I'd like to write or update documentation](#how-to-write-or-update-documentation)
10
+
*[I don't know how to upload code to GitHub](https://www.brentozar.com/archive/2015/07/pull-request-101-for-dbas-using-github/)
10
11
11
12
Everyone here is expected to abide by the [Contributor Covenant Code of Conduct](#the-contributor-covenant-code-of-conduct).
12
13
13
-
Wanna do something else, or have a question not answered here? Hop into Slack and ask us questions before you get started. [Join SQLServer.slack.com](https://sql-server-slack.herokuapp.com/), and we're in the [#FirstResponderKit channel](https://sqlserver.slack.com/messages/firstresponderkit/). We welcome newcomers, and there's always a way you can help.
14
+
Wanna do something else, or have a question not answered here? Hop into Slack and ask us questions before you get started. [Get an invite to SQLCommunity.slack.com](https://sqlps.io/slack/), and we're in the [#FirstResponderKit channel](https://sqlcommunity.slack.com/messages/firstresponderkit/). We welcome newcomers, and there's always a way you can help.
14
15
15
16
## How to Report Bugs or Request Enhancements
16
17
17
-
[Check out the Github issues list.](https://github.com/BrentOzarULTD/SQL-Server-First-Responder-Kit/issues) Search for what you're interested in - there may already be an issue for it. Make sure to search through closed issues, too, because we often decline things that aren't a good fit for these tools.
18
+
Check out the [Github issues list]. Search for what you're interested in - there may already be an issue for it. Make sure to search through closed issues, too, because we often decline things that aren't a good fit for these tools.
18
19
19
20
If you can't find a similar issue, go ahead and open your own. Include as much detail as you can - what you're seeing now, and what you'd like to see.
20
21
@@ -24,11 +25,11 @@ When requesting new checks, keep in mind that we want to focus on:
24
25
* Performance issues or reliability risks - if it's just a setting we don't agree with, let's set that aside
25
26
* Things that end users or managers will notice - if we're going to have someone change a setting on their system, we want it to be worth their time
26
27
27
-
Now [head on over to the Github issues list](https://github.com/BrentOzarULTD/SQL-Server-First-Responder-Kit/issues) and get started.
28
+
Now head on over to the [Github issues list] and get started.
28
29
29
30
## How to Write New T-SQL Checks
30
31
31
-
Before you code, check the [Github issues list](https://github.com/BrentOzarULTD/SQL-Server-First-Responder-Kit/issues) for what you're trying to do - there may already be an issue for it. Make sure to search through closed issues, too, because we often decline things that aren't a good fit for these tools.
32
+
Before you code, check the [Github issues list] for what you're trying to do - there may already be an issue for it. Make sure to search through closed issues, too, because we often decline things that aren't a good fit for these tools.
32
33
33
34
If you've got a new idea that isn't covered in an existing issue, open a Github issue for it. Outline what you'd like to do, and how you'd like to code it. This just helps make sure other users agree that it's a good idea to add to these tools.
34
35
@@ -100,5 +101,61 @@ Project maintainers who do not follow or enforce the Code of Conduct in good fai
100
101
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
101
102
available at [http://contributor-covenant.org/version/1/4][version]
102
103
104
+
105
+
## Git Flow for pull requests
106
+
<aname="git-flow"></a>
107
+
108
+
1.[Fork] the project, clone your fork, and configure the remotes:
109
+
110
+
```bash
111
+
# Clone your fork of the repo into the current directory
This doc explains how to do a release of the First Responder Kit scripts.
6
+
7
+
It's for internal use at BrentOzar.com, but other folks might find it useful.
8
+
9
+
Well, useful is probably the wrong word. More like entertaining. Here we go.
10
+
11
+
## Preparations
12
+
13
+
* Create a Milestone to tag issues/PRs as you work on them. In Github, go into Issues, Milestones (button at the top), and add a new milestone named YYYY-MM, like 2017-01.
14
+
* As you merge pull requests into the dev branch (or before), tag them with the milestone. This makes it easy to find the related issues when you go to write release notes.
15
+
16
+
17
+
## Finalize and Test the Code
18
+
19
+
* Make sure all issues in the milestone are closed - click Issues, Milestones, and it'll show the percent complete. If there's any issues you want to bump to the next round, add the next round's milestone and tag the issues with it.
20
+
* When enough PRs are in dev, do a round of code testing in 2008-2016 in the cloud lab.
21
+
* Merge scripts into three files:
22
+
* Runs command in Merge Blitz.ps1
23
+
* These get moved to AWS for testing
24
+
* Run _TestBed.sql: this has stored proc calls with common parameters. May have to add in new scenarios if new features are added.
25
+
* If it passes, bump all the version numbers inside the scripts and re-run the PowerShell commands so combined scripts reflect correct version and date.
26
+
* sp_foreachdb @Version and @VersionDate
27
+
* sp_BlitzWho @Version and @VersionDate
28
+
* sp_BlitzIndex @Version and @VersionDate
29
+
* sp_BlitzFirst @VersionDate (no version)
30
+
* sp_BlitzCache @Version and @VersionDate
31
+
* sp_Blitz @Version and @VersionDate
32
+
* sp_DatabaseRestore @Version and @VersionDate
33
+
* sp_BlitzBackups @Version and @VersionDate
34
+
* sp_BlitzQueryStore @Version and @VersionDate
35
+
* sp_AllNightLog @Version and @VersionDate
36
+
* sp_AllNightLog_Setup @Version and @VersionDate
37
+
38
+
## Push to Master
39
+
40
+
* Push to the master branch from dev. (Make sure you're pushing FROM dev, TO master.)
41
+
* Draft a new release. Click Code, Releases, and edit one of the recent releases to get the Markdown syntax. Copy/paste that into a new release, and put the issue numbers for the relevant changes.
42
+
* Publish the release pointing at the current master branch code (not dev).
43
+
44
+
## Announce It
45
+
46
+
* Copy the FRK scripts into BrentOzar.com's First Responder Kit zip file (Employees/Products/First Responder Kit/FirstResponderKit.zip)
47
+
* Copy the FirstResponderKit.zip into Employees/Public.BrentOzar
48
+
* Copy the Github release text into a WordPress blog post with the First Responder Kit category. The nice thing about doing the Github release first is that you should be able to copy/paste the Github release page and the HTML should paste smoothly into the WordPress draft window, complete with links to the Github issues. At the end of the post, put a download now link that points to: https://www.brentozar.com/first-aid/
0 commit comments