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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-5Lines changed: 7 additions & 5 deletions
Original file line number
Diff line number
Diff 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.
2
2
3
3
-[CLAs and CCLAs](#clas-and-cclas)
4
4
-[Feature Request](#feature-request)
@@ -64,6 +64,8 @@ In order to make the process easier, we've included a [sample bug report templat
64
64
65
65
We welcome direct contributions to the sendgrid-java code base. Thank you!
66
66
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
+
67
69
### Development Environment ###
68
70
69
71
#### Install and Run Locally ####
@@ -193,7 +195,7 @@ Please run your code through:
193
195
contain your feature, change, or fix:
194
196
195
197
```bash
196
-
git checkout -b <topic-branch-name>
198
+
git checkout -b <topic-branch-name> development
197
199
```
198
200
199
201
4. Commit your changes in logical chunks. Please adhere to these [git commit
@@ -206,10 +208,10 @@ Please run your code through:
206
208
207
209
4b. Create or update the example code that demonstrates the functionality of this change to the code.
208
210
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:
210
212
211
213
```bash
212
-
git pull [--rebase] upstream master
214
+
git pull [--rebase] upstream development
213
215
```
214
216
215
217
6. Push your topic branch up to your fork:
@@ -219,6 +221,6 @@ Please run your code through:
219
221
```
220
222
221
223
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.
223
225
224
226
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