Skip to content

Commit c2a7606

Browse files
committed
Update CONTRIBUTING - contribution guideline to branch off development
1 parent 62a985c commit c2a7606

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

.github/PULL_REQUEST_TEMPLATE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Closes #2
1212
### Checklist
1313
- [ ] I have made a material change to the repo (functionality, testing, spelling, grammar)
1414
- [ ] I have read the [Contribution Guide] and my PR follows them.
15-
- [ ] I updated my branch with the master branch.
15+
- [ ] I updated my branch with the development branch.
1616
- [ ] I have added tests that prove my fix is effective or that my feature works
1717
- [ ] I have added necessary documentation about the functionality in the appropriate .md file
1818
- [ ] I have added in line documentation to the code I modified

CONTRIBUTING.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Hello! Thank you for choosing to help contribute to one of the SendGrid open source libraries. There are many ways you can contribute and help is always welcome. We simply ask that you follow the following contribution policies.
1+
Hello! Thank you for choosing to help contribute to one of the SendGrid open source libraries. There are many ways you can contribute and help is always welcome. We simply ask that you follow the following contribution policies.
22

33
- [CLAs and CCLAs](#cla)
44
- [Roadmap & Milestones](#roadmap)
@@ -59,6 +59,8 @@ In order to make the process easier, we've included a [sample bug report templat
5959

6060
We welcome direct contributions to the sendgrid-php code base. Thank you!
6161

62+
Please note that we utilize the [Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) for Git to help keep project development organized and consistent.
63+
6264
### Development Environment ###
6365

6466
#### Install and Run Locally ####
@@ -161,10 +163,11 @@ Please run your code through:
161163
git pull upstream <dev-branch>
162164
```
163165

164-
3. Create a new topic branch (off the main project development branch) to
166+
3. Create a new topic branch off the `development` branch to
165167
contain your feature, change, or fix:
166168

167169
```bash
170+
git checkout development
168171
git checkout -b <topic-branch-name>
169172
```
170173

@@ -178,10 +181,10 @@ Please run your code through:
178181

179182
4b. Create or update the example code that demonstrates the functionality of this change to the code.
180183

181-
5. Locally merge (or rebase) the upstream development branch into your topic branch:
184+
5. Locally merge (or rebase) the upstream `development` branch into your topic branch:
182185

183186
```bash
184-
git pull [--rebase] upstream master
187+
git pull [--rebase] upstream development
185188
```
186189

187190
6. Push your topic branch up to your fork:
@@ -191,7 +194,7 @@ Please run your code through:
191194
```
192195

193196
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
194-
with a clear title and description against the `master` branch. All tests must be passing before we will review the PR.
197+
with a clear title and description against the `development` branch. All tests must be passing before we will review the PR.
195198

196199
If you have any additional questions, please feel free to [email](mailto:dx@sendgrid.com) us or create an issue in this repo.
197200

0 commit comments

Comments
 (0)