Hello! Thank you for choosing to help contribute to one of the Twilio SendGrid open source libraries. There are many ways you can contribute and help is always welcome. We simply ask that you follow the following contribution policies.
All third party contributors acknowledge that any contributions they provide will be made under the same open source license that the open source project is provided under.
- Feature Request
- Submit a Bug Report
- Improvements to the Codebase
- Understanding the Code Base
- Testing
- Style Guidelines & Naming Conventions
- Creating a Pull Request
- Code Reviews
We use Milestones to help define current roadmaps, please feel free to grab an issue from the current milestone. Please indicate that you have begun work on it to avoid collisions. Once a PR is made, community reviews, comments, suggestions, and additional PRs are welcomed and encouraged.
There are a few ways to contribute, which we'll enumerate below:
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 in order to ensure we don't have duplicate bugs/feature requests.
- Please be respectful and considerate of others when commenting on issues
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. In order 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:
- Check the GitHub issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post.
- Update to the latest version of this code and check if the issue has already been fixed
- Copy and fill in the Bug Report Template we have provided below
In order to make the process easier, we've included a sample bug report template (borrowed from Ghost). The template uses GitHub flavored markdown for formatting.
We welcome direct contributions to the sendgrid-python code base. Thank you!
This is usually the easiest and fastest way to get set up. You can use our Docker image to avoid setting up the development environment yourself. See USAGE.md.
- Python 2.7 and 3.4+
- python_http_client
git clone https://github.com/sendgrid/sendgrid-python.git
cd sendgrid-pythonFirst, get your free Twilio SendGrid account here.
Next, update your environment with your SENDGRID_API_KEY.
cp .env_sample .envThen edit .env and insert your API key.
# You do not need to do this when using Docker Compose
source .envSee the examples folder to get started quickly.
If testing from the root directory of this repo, create a new file (e.g. test.py) and replace import sendgrid with from sendgrid import *
/examples
Working examples that demonstrate usage.
/tests
Currently, we have unit and profiling tests.
/sendgrid
The Web API v3 client is sendgrid.py, the other files are legacy code for our mail send v2 endpoint.
The PR must pass all the tests before it is reviewed.
All test files are in the test directory.
For the purposes of contributing to this repo, please update the test_sendgrid.py file with unit tests as you modify the code.
python -m unittest discover -v
The PR must pass all the tests before it is reviewed.
The above local "Initial setup" is complete
- pyenv
- tox
- prism v0.6 - It should be available in your PATH, but unittest script
will try to install it locally if not found. Apart from PATH env variable it will check in
~/binand/usr/local/bin. You can install it by yourself in user dir by callingsource test/prism.sh.
Add eval "$(pyenv init -)" to your shell environment (.profile, .bashrc, etc) after installing tox, you only need to do this once.
pyenv install 2.7.11
pyenv install 3.4.3
pyenv install 3.5.0
Make sure to change the current working directory to your local version of the repo before running the following command:
python setup.py install
pyenv local 3.5.0 3.4.3 2.7.11
pyenv rehash
source venv/bin/activate
tox
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:
-
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/sendgrid-python # Navigate to the newly cloned directory cd sendgrid-python # Assign the original repo to a remote called "upstream" git remote add upstream https://github.com/sendgrid/sendgrid-python
-
If you cloned a while ago, get the latest changes from upstream:
git checkout <dev-branch> git pull upstream <dev-branch>
-
Create a new topic branch (of the main project development branch) to contain your feature, change, or fix:
git checkout -b <topic-branch-name>
-
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.
-
Locally merge (or rebase) the upstream development branch into your topic branch:
git pull [--rebase] upstream master
-
Push your topic branch up to your fork:
git push origin <topic-branch-name>
-
Open a Pull Request with a clear title and description against the
masterbranch. All tests must be passing before we will review the PR.
If you have any additional questions, please feel free to email us or create an issue in this repo.
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.