Skip to content

Commit 21239b1

Browse files
Merge pull request #79 from anatolyyyyyy/update-contribution-gitflow
Update contribution to use Gitflow workflow
2 parents 3cda3f4 + 56ccc02 commit 21239b1

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 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.
22

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

5959
We welcome direct contributions to the smtpapi-python code base. Thank you!
6060

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+
6163
### Development Environment ###
6264

6365
#### Install and Run Locally ####
@@ -140,7 +142,7 @@ Please run your code through:
140142
git pull upstream <dev-branch>
141143
```
142144

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
144146
contain your feature, change, or fix:
145147

146148
```bash
@@ -157,10 +159,10 @@ Please run your code through:
157159

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

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:
161163

162164
```bash
163-
git pull [--rebase] upstream master
165+
git pull [--rebase] upstream development
164166
```
165167

166168
6. Push your topic branch up to your fork:
@@ -170,6 +172,6 @@ Please run your code through:
170172
```
171173

172174
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.
174176

175177
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)