-
Notifications
You must be signed in to change notification settings - Fork 625
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
61 changed files
with
11,487 additions
and
3,687 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
#### Issue Summary | ||
|
||
A summary of the issue and the environment in which it occurs. If suitable, include the steps required to reproduce the bug. Please feel free to include screenshots, screencasts, code examples. | ||
|
||
|
||
#### Steps to Reproduce | ||
|
||
1. This is the first step | ||
2. This is the second step | ||
3. Further steps, etc. | ||
|
||
Any other information you want to share that is relevant to the issue being reported. Especially, why do you consider this to be a bug? What do you expect to happen instead? | ||
|
||
#### Technical details: | ||
|
||
* sendgrid-php Version: master (latest commit: [commit number]) | ||
* PHP Version: 5.x |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,9 @@ | ||
test/coverage/* | ||
examples/* | ||
dist/ | ||
composer.lock | ||
vendor | ||
.env* | ||
sendgrid-php.php | ||
composer.phar | ||
example.php | ||
.editorconfig | ||
test.php |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,193 @@ | ||
Hello! Thank you for choosing to help contribute to one of the 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. | ||
|
||
- [CLAs and CCLAs](#cla) | ||
- [Roadmap & Milestones](#roadmap) | ||
- [Feature Request](#feature_request) | ||
- [Submit a Bug Report](#submit_a_bug_report) | ||
- [Improvements to the Codebase](#improvements_to_the_codebase) | ||
- [Understanding the Code Base](#understanding_the_codebase) | ||
- [Testing](#testing) | ||
- [Style Guidelines & Naming Conventions](#style_guidelines_and_naming_conventions) | ||
- [Creating a Pull Request](#creating_a_pull_request) | ||
|
||
<a name="roadmap"></a> | ||
We use [Milestones](https://github.com/sendgrid/sendgrid-php/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 review, comments, suggestions and additional PRs are welcomed and encouraged. | ||
|
||
<a name="cla"></a> | ||
## CLAs and CCLAs | ||
|
||
Before you get started, SendGrid requires that a SendGrid Contributor License Agreement (CLA) or a SendGrid Company Contributor Licensing Agreement (CCLA) be filled out by every contributor to a SendGrid open source project. | ||
|
||
Our goal with the CLA and CCLA is to clarify the rights of our contributors and reduce other risks arising from inappropriate contributions. The CLA also clarifies the rights SendGrid holds in each contribution and helps to avoid misunderstandings over what rights each contributor is required to grant to SendGrid when making a contribution. In this way the CLA and CCLA encourage broad participation by our open source community and help us build strong open source projects, free from any individual contributor withholding or revoking rights to any contribution. | ||
|
||
SendGrid does not merge a pull request made against a SendGrid open source project until that pull request is associated with a signed CLA (or CCLA). Copies of the CLA and CCLA are available [here](https://drive.google.com/a/sendgrid.com/file/d/0B0PlcM9qA91LN2VEUTJWU2RIVXc/view). | ||
|
||
You may submit your completed [CLA or CCLA](https://drive.google.com/a/sendgrid.com/file/d/0B0PlcM9qA91LN2VEUTJWU2RIVXc/view) to SendGrid at [[email protected]](mailto:[email protected]). SendGrid will then confirm you are ready to begin making contributions. | ||
|
||
There are a few ways to contribute, which we'll enumerate below: | ||
|
||
<a name="feature_request"></a> | ||
## 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** in order to ensure we don't have duplicate bugs/feature requests. | ||
- Please be respectful and considerate of others when commenting on issues | ||
|
||
<a name="submit_a_bug_report"></a> | ||
## 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. 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: | ||
|
||
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 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](https://github.com/sendgrid/sendgrid-php/.github/ISSUE_TEMPLATE) (borrowed from [Ghost](https://github.com/TryGhost/Ghost/)). The template uses [GitHub flavored markdown](https://help.github.com/articles/github-flavored-markdown/) for formatting. | ||
|
||
<a name="improvements_to_the_codebase"></a> | ||
## Improvements to the Codebase | ||
|
||
We welcome direct contributions to the sendgrid-php code base. Thank you! | ||
|
||
### Development Environment ### | ||
|
||
#### Install and Run Locally #### | ||
|
||
##### Prerequisites ##### | ||
|
||
- PHP 5.4 or greater | ||
- [php-http-client](https://github.com/sendgrid/php-http-client) | ||
|
||
##### Initial setup: ##### | ||
|
||
```bash | ||
git clone https://github.com/sendgrid/sendgrid-php.git | ||
cd sendgrid-php | ||
composer install | ||
``` | ||
|
||
## Environment Variables | ||
|
||
First, get your free SendGrid account [here](https://sendgrid.com/free?source=sendgrid-php). | ||
|
||
Next, update your environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys). | ||
|
||
```bash | ||
echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env | ||
echo "sendgrid.env" >> .gitignore | ||
source ./sendgrid.env | ||
``` | ||
|
||
##### Execute: ##### | ||
|
||
See the [examples folder](https://github.com/sendgrid/sendgrid-php/tree/master/examples) to get started quickly. | ||
|
||
If you are using composer, replace <PATH_TO> with the path to your `vendor/autoload.php`. Otherwise, include lib/SendGrid.php and lib/helpers/mail/Mail.php. | ||
|
||
<a name="understanding_the_codebase"></a> | ||
## Understanding the Code Base | ||
|
||
**/examples** | ||
|
||
Working examples that demonstrate usage. | ||
|
||
```bash | ||
php examples/example.php | ||
``` | ||
|
||
**/test/unit** | ||
|
||
Unit tests for the HTTP client. | ||
|
||
**/lib** | ||
|
||
The interface to the SendGrid API. | ||
|
||
<a name="testing"></a> | ||
## Testing | ||
|
||
All PRs require passing tests before the PR will be reviewed. | ||
|
||
All test files are in the [`/test/unit`](https://github.com/sendgrid/sendgrid-php/tree/master/test/unit) directory. | ||
|
||
For the purposes of contributing to this repo, please update the [`SendGridTest.php`](https://github.com/sendgrid/sendgrid-php/tree/master/test/unit/SendGridTest.php) file with unit tests as you modify the code. | ||
|
||
```bash | ||
cd test/unit | ||
../../vendor/bin/phpunit . --bootstrap bootstrap.php --filter test* | ||
``` | ||
|
||
<a name="style_guidelines_and_naming_conventions"></a> | ||
## 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. | ||
|
||
- [pear coding standards](https://pear.php.net/manual/en/standards.php) | ||
|
||
Please run your code through: | ||
|
||
- [PHP Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer) | ||
|
||
## Creating a Pull Request<a name="creating_a_pull_request"></a> | ||
|
||
1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork, | ||
and configure the remotes: | ||
|
||
```bash | ||
# 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-python | ||
# Assign the original repo to a remote called "upstream" | ||
git remote add upstream https://github.com/sendgrid/sendgrid-php | ||
``` | ||
|
||
2. If you cloned a while ago, get the latest changes from upstream: | ||
|
||
```bash | ||
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: | ||
|
||
```bash | ||
git checkout -b <topic-branch-name> | ||
``` | ||
|
||
4. Commit your changes in logical chunks. Please adhere to these [git commit | ||
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) | ||
or your code is unlikely be merged into the main project. Use Git's | ||
[interactive rebase](https://help.github.com/articles/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: | ||
|
||
```bash | ||
git pull [--rebase] upstream master | ||
``` | ||
|
||
6. Push your topic branch up to your fork: | ||
|
||
```bash | ||
git push origin <topic-branch-name> | ||
``` | ||
|
||
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) | ||
with a clear title and description against the `master` branch. All tests must be passing before we will review the PR. | ||
|
||
If you have any additional questions, please feel free to [email](mailto:[email protected]) us or create an issue in this repo. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.