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
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
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](#cla)
4
4
-[Roadmap & Milestones](#roadmap)
@@ -59,6 +59,8 @@ In order to make the process easier, we've included a [sample bug report templat
59
59
60
60
We welcome direct contributions to the sendgrid-php code base. Thank you!
61
61
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
+
62
64
### Development Environment ###
63
65
64
66
#### Install and Run Locally ####
@@ -161,10 +163,11 @@ Please run your code through:
161
163
git pull upstream <dev-branch>
162
164
```
163
165
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
165
167
contain your feature, change, or fix:
166
168
167
169
```bash
170
+
git checkout development
168
171
git checkout -b <topic-branch-name>
169
172
```
170
173
@@ -178,10 +181,10 @@ Please run your code through:
178
181
179
182
4b. Create or update the example code that demonstrates the functionality of this change to the code.
180
183
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:
182
185
183
186
```bash
184
-
git pull [--rebase] upstream master
187
+
git pull [--rebase] upstream development
185
188
```
186
189
187
190
6. Push your topic branch up to your fork:
@@ -191,7 +194,7 @@ Please run your code through:
191
194
```
192
195
193
196
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.
195
198
196
199
If you have any additional questions, please feel free to [email](mailto:dx@sendgrid.com) us or create an issue in this repo.
0 commit comments