Skip to content

Commit 4ac4891

Browse files
committed
Add Git Flow for pull requests to CONTRIBUTING.md
Fix markdown in ISSUE_TEMPLATE.md Rename PULL_REQUEST_TEMPLATE to PULL_REQUEST_TEMPLATE.md
1 parent c4dc7f1 commit 4ac4891

3 files changed

Lines changed: 56 additions & 1 deletion

File tree

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**What is the current behavior?**
44

5-
**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
5+
**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**
66

77
**What is the expected behavior?**
88

File renamed without changes.

‎CONTRIBUTING.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,61 @@ Project maintainers who do not follow or enforce the Code of Conduct in good fai
101101
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
102102
available at [http://contributor-covenant.org/version/1/4][version]
103103

104+
105+
## Git Flow for pull requests
106+
<a name="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
112+
git clone git@github.com:<YOUR_USERNAME>/SQL-Server-First-Responder-Kit.git
113+
# Navigate to the newly cloned directory
114+
cd SQL-Server-First-Responder-Kit
115+
# Assign the original repo to a remote called "upstream"
116+
git remote add upstream https://github.com/BrentOzarULTD/SQL-Server-First-Responder-Kit/
117+
```
118+
119+
2. If you cloned a while ago, get the latest changes from upstream:
120+
121+
```bash
122+
git checkout master
123+
git pull upstream master
124+
```
125+
126+
3. Create a new topic branch (off the main project development branch) to
127+
contain your feature, change, or fix:
128+
129+
```bash
130+
git checkout -b <topic-branch-name>
131+
```
132+
133+
4. Commit your changes in logical chunks. Please adhere to these [git commit message guidelines]
134+
or your code is unlikely be merged into the main project. Use Git's [interactive rebase]
135+
feature to tidy up your commits before making them public.
136+
137+
5. Locally merge (or rebase) the upstream development branch into your topic branch:
138+
139+
```bash
140+
git pull [--rebase] upstream master
141+
```
142+
143+
6. Push your topic branch up to your fork:
144+
145+
```bash
146+
git push origin <topic-branch-name>
147+
```
148+
149+
7. [Open a Pull Request] with a clear title and description.
150+
151+
**IMPORTANT**: By submitting a patch, you agree to allow the project owner to license your work under the MIT [LICENSE]
152+
153+
104154
[homepage]: http://contributor-covenant.org
105155
[version]: http://contributor-covenant.org/version/1/4/
106156
[Github issues list]:https://github.com/BrentOzarULTD/SQL-Server-First-Responder-Kit/issues
157+
[Fork]:https://help.github.com/articles/fork-a-repo/
158+
[git commit message guidelines]:http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
159+
[interactive rebase]:https://help.github.com/articles/about-git-rebase/
160+
[Open a Pull Request]:https://help.github.com/articles/about-pull-requests/
161+
[LICENSE]:https://github.com/BrentOzarULTD/SQL-Server-First-Responder-Kit/blob/master/LICENSE.md

0 commit comments

Comments
 (0)