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
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 projects. 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 projects. 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)
@@ -58,6 +58,8 @@ In order to make the process easier, we've included a [sample bug report templat
58
58
59
59
We welcome direct contributions to the smtpapi-python code base. Thank you!
60
60
61
+
Please note that we use the [Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) for Git to help keep project development organized and consistent.
62
+
61
63
### Development Environment ###
62
64
63
65
#### Install and Run Locally ####
@@ -140,7 +142,7 @@ Please run your code through:
140
142
git pull upstream <dev-branch>
141
143
```
142
144
143
-
3. Create a new topic branch (off the main project development branch) to
145
+
3. Create a new topic branch off the `development` branch to
144
146
contain your feature, change, or fix:
145
147
146
148
```bash
@@ -157,10 +159,10 @@ Please run your code through:
157
159
158
160
4b. Create or update the example code that demonstrates the functionality of this change to the code.
159
161
160
-
5. Locally merge (or rebase) the upstream development branch into your topic branch:
162
+
5. Locally merge (or rebase) the upstream `development` branch into your topic branch:
161
163
162
164
```bash
163
-
git pull [--rebase] upstream master
165
+
git pull [--rebase] upstream development
164
166
```
165
167
166
168
6. Push your topic branch up to your fork:
@@ -170,6 +172,6 @@ Please run your code through:
170
172
```
171
173
172
174
7.[Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
173
-
with a clear title and description against the `master` branch. All tests must be passing before we will review the PR.
175
+
with a clear title and description against the `development` branch. All tests must be passing before we will review the PR.
174
176
175
177
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