From 56ccc025f7ccdfba1d9f0909a191ef5e617ed7e4 Mon Sep 17 00:00:00 2001 From: anatolyyyyyy Date: Sat, 13 Oct 2018 14:18:48 +0300 Subject: [PATCH] Update contribution to use Gitflow workflow --- .github/PULL_REQUEST_TEMPLATE | 2 +- CONTRIBUTING.md | 12 +++++++----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index 7ad590b..75ee89b 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -12,7 +12,7 @@ Closes #2 ### Checklist - [ ] I have made a material change to the repo (functionality, testing, spelling, grammar) - [ ] I have read the [Contribution Guide] and my PR follows them. -- [ ] I updated my branch with the master branch. +- [ ] I updated my branch with the `development` branch. - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have added necessary documentation about the functionality in the appropriate .md file - [ ] I have added in line documentation to the code I modified diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8d41b42..55f5fad 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -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. +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. - [CLAs and CCLAs](#cla) - [Roadmap & Milestones](#roadmap) @@ -58,6 +58,8 @@ In order to make the process easier, we've included a [sample bug report templat We welcome direct contributions to the smtpapi-python code base. Thank you! +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. + ### Development Environment ### #### Install and Run Locally #### @@ -140,7 +142,7 @@ Please run your code through: git pull upstream ``` -3. Create a new topic branch (off the main project development branch) to +3. Create a new topic branch off the `development` branch to contain your feature, change, or fix: ```bash @@ -157,10 +159,10 @@ Please run your code through: 4b. Create or update the example code that demonstrates the functionality of this change to the code. -5. Locally merge (or rebase) the upstream development branch into your topic branch: +5. Locally merge (or rebase) the upstream `development` branch into your topic branch: ```bash - git pull [--rebase] upstream master + git pull [--rebase] upstream development ``` 6. Push your topic branch up to your fork: @@ -170,6 +172,6 @@ Please run your code through: ``` 7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) - with a clear title and description against the `master` branch. All tests must be passing before we will review the PR. + with a clear title and description against the `development` branch. All tests must be passing before we will review the PR. If you have any additional questions, please feel free to [email](mailto:dx@sendgrid.com) us or create an issue in this repo.