Skip to content

Latest commit

 

History

History
152 lines (100 loc) · 5.07 KB

CONTRIBUTING.md

File metadata and controls

152 lines (100 loc) · 5.07 KB
Raw

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 merely ask that you follow the following contribution policies.

Improvements to the Codebase

We welcome direct contributions to the php-http-client code base. Thank you!

Development Environment

Install and Run Locally

Prerequisites
  • PHP version 7.3, 7.4, 8.0, or 8.1
  • Composer
Initial setup:
git clone https://github.com/sendgrid/php-http-client.git
cd php-http-client

Environment Variables

First, get your free 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
Execute:

See the examples folder.

Understanding the Code Base

/examples

Working examples that demonstrate usage.

/test/unit

Unit tests.

/lib/SendGrid/Client.php

An HTTP client with a fluent interface using method chaining and reflection. By returning $this on __call, we can dynamically build the URL using method chaining and __call allows us to dynamically receive the method calls to achieve reflection.

This allows for the following mapping from a URL to a method chain:

/api_client/{api_key_id}/version maps to client->api_client().->_($api_key_id)->version-><method>() where is a HTTP verb.

/lib/SendGrid/Config.php

Loads the environment variables.

Testing

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 the ClientTest.php file with unit tests as you modify the code.

composer install
cd test/unit
../../vendor/bin/phpunit . --bootstrap bootstrap.php --filter test*

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/php-http-client
# Navigate to the newly cloned directory
cd php-http-client
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/sendgrid/php-http-client

  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 main project 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 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 main

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