CONTRIBUTING.md

Hello! Thank you for choosing to help contribute to one of the Twilio 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.

• Improvements to the Codebase
• Understanding the Code Base
• Testing
• Style Guidelines & Naming Conventions
• Creating a Pull Request
• Code Reviews

Improvements to the Codebase

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

Please note that we use the Gitflow Workflow for Git to help keep project development organized and consistent.

Development Environment

Install and Run Locally

Prerequisites

• Python 2.6, 2.7, 3.4 and 3.5

Initial setup:

git clone https://github.com/sendgrid/smtpapi-python.git
cd smtpapi-python

Execute:

See the examples folder to get started quickly.

Understanding the Code Base

/examples

Working examples that demonstrate usage.

/test

Unit tests.

/smtpapi/init.py

Builds the SMTPAPI header.

Testing

All PRs require passing tests before the PR will be reviewed.

All the test files are in the test directory.

For the purposes of contributing to this repo, please update the __init__.py file with unit tests as you modify the code.

python setup.py install
python test/__init__.py

Style Guidelines & Naming Conventions

Generally, we follow the style guidelines as suggested by the official language. However, we ask that you conform to the styles that already exist in the library. If you wish to deviate, please explain your reasoning.

• PEP8

Please run your code through:

• pyflakes
• pylint
• pep8

Creating a Pull Request

1. Fork the project, clone your fork, and configure the remotes:

   # Clone your fork of the repo into the current directory
   git clone https://github.com/sendgrid/smtpapi-python
   # Navigate to the newly cloned directory
   cd smtpapi-python
   # Assign the original repo to a remote called "upstream"
   git remote add upstream https://github.com/sendgrid/smtpapi-python

2. If you cloned a while ago, get the latest changes from upstream:

   git checkout <dev-branch>
   git pull upstream <dev-branch>

3. Create a new topic branch off the development branch to contain your feature, change, or fix:

   git checkout -b <topic-branch-name>

4. Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your code is unlikely to be merged into the main project. Use Git's interactive rebase feature to tidy up your commits before making them public.

4a. Create tests.

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:

   git pull [--rebase] upstream development

6. Push your topic branch up to your fork:

   git push origin <topic-branch-name>

7. Open a Pull Request with a clear title and description against the development branch. All tests must be passing before we will review the PR.

Code Reviews

If you can, please look at open PRs and review them. Give feedback and help us merge these PRs much faster! If you don't know how, GitHub has some great information on how to review a Pull Request.