Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
164 lines (108 loc) · 5.63 KB

CONTRIBUTING.md

File metadata and controls

164 lines (108 loc) · 5.63 KB

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.

Feature Request

If you'd like to make a feature request, please read this section.

The GitHub issue tracker is the preferred channel for library feature requests, but please respect the following restrictions:

  • Please search for existing issues to ensure we don't have duplicate bugs/feature requests.
  • Please be respectful and considerate of others when commenting on issues.

Submit a Bug Report

Note: DO NOT include your credentials in ANY code examples, descriptions, or media you make public.

A software bug is a demonstrable issue in the code base. For us to diagnose the issue and respond as quickly as possible, please add as much detail as possible into your bug report.

Before you decide to create a new issue, please try the following:

  1. Check the Github issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post.
  2. Update to the latest version of this code and check if the issue has already been fixed.
  3. Copy and fill in the Bug Report Template we have provided below.

Please use our Bug Report Template

In order to make the process easier, we've included a sample bug report template.

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.

Please run your code through:

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.

  1. Locally merge (or rebase) the upstream development branch into your topic branch:

    git pull [--rebase] upstream development

  2. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

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