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.
- Improvements to the Codebase
- Understanding the Code Base
- Style Guidelines & Naming Conventions
- Creating a Pull Request
- Code Reviews
There are a few ways to contribute, which we'll enumerate below:
Improvements to the Codebase
We welcome direct contributions to the sendgrid-php code base. Thank you!
Please note that we utilize the Gitflow Workflow for Git to help keep project development organized and consistent.
Install and Run Locally
- PHP version 7.3, 7.4, 8.0, or 8.1
git clone https://github.com/sendgrid/sendgrid-php.git cd sendgrid-php composer install
First, get your free Twilio SendGrid account here.
Next, update your environment with your SENDGRID_API_KEY.
echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env echo "sendgrid.env" >> .gitignore source ./sendgrid.env
We prefer the use of the Composer autoloader by loading
The examples will load
sendgrid-php.php which is in the project root. This file verifies the existence of the Composer autoloader and warns you if dependencies are missing.
Understanding the Codebase
Working examples that demonstrate usage.
Unit tests for the HTTP client.
Unit tests for the HTTP client.
The interface to the Twilio SendGrid API. The subfolders are helpers.
All PRs require passing tests before the PR will be reviewed. All test files are in the
/test/unit directory. For the purposes of contributing to this repo, please update or add relevant test files here with tests as you modify the code.
The integration tests require a Twilio SendGrid mock API in order to execute. We've simplified setting this up using Docker to run the tests. You will just need Docker Desktop and
Once these are available, simply execute the Docker test target to run all tests:
make test-docker. This command can also be used to open an interactive shell into the container where this library is installed. To start a bash shell for example, use this command:
command=bash make test-docker.
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
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-php # Navigate to the newly cloned directory cd sendgrid-php # Assign the original repo to a remote called "upstream" git remote add upstream https://github.com/sendgrid/sendgrid-php
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 off the
developmentbranch to contain your feature, change, or fix:
git checkout development 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
developmentbranch into your topic branch:
git pull [--rebase] upstream development
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
developmentbranch. All tests must be passing before we will review the PR.
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.