Skip to content

Commit 7560a8d

Browse files
Merge pull request sendgrid#500 from pushkyn/contibuting-gitflow-workflow
Update CONTRIBUTING - using gitflow workflow, development branch inst…
2 parents 9bc569c + e160d8f commit 7560a8d

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-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: 7 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](#clas-and-cclas)
44
- [Feature Request](#feature-request)
@@ -64,6 +64,8 @@ In order to make the process easier, we've included a [sample bug report templat
6464

6565
We welcome direct contributions to the sendgrid-java code base. Thank you!
6666

67+
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.
68+
6769
### Development Environment ###
6870

6971
#### Install and Run Locally ####
@@ -193,7 +195,7 @@ Please run your code through:
193195
contain your feature, change, or fix:
194196

195197
```bash
196-
git checkout -b <topic-branch-name>
198+
git checkout -b <topic-branch-name> development
197199
```
198200

199201
4. Commit your changes in logical chunks. Please adhere to these [git commit
@@ -206,10 +208,10 @@ Please run your code through:
206208

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

209-
5. Locally merge (or rebase) the upstream development branch into your topic branch:
211+
5. Locally merge (or rebase) the upstream `development` branch into your topic branch:
210212

211213
```bash
212-
git pull [--rebase] upstream master
214+
git pull [--rebase] upstream development
213215
```
214216

215217
6. Push your topic branch up to your fork:
@@ -219,6 +221,6 @@ Please run your code through:
219221
```
220222

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

224226
If you have any additional questions, please feel free to [email](mailto:[email protected]) us or create an issue in this repo.

0 commit comments

Comments
 (0)