Skip to content

Latest commit

 

History

History
216 lines (142 loc) · 8.64 KB

CONTRIBUTING.md

File metadata and controls

216 lines (142 loc) · 8.64 KB

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.

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 review, comments, suggestions and additional PRs are welcomed and encouraged.

There are a few ways to contribute, which we'll enumerate below:

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

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 (borrowed from Ghost). The template uses GitHub flavored markdown for formatting.

Improvements to the Codebase

We welcome direct contributions to the sendgrid-java code base. Thank you!

Please note that we utilize the Gitflow Workflow for Git to help keep project development organized and consistent.

Development Environment

Install and Run Locally

Prerequisites
Initial setup:
git clone https://github.com/sendgrid/sendgrid-java.git
cd sendgrid-java

Environment Variables

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
./gradlew build
Execute:

See the examples folder to get started quickly.

Check out the documentation for Web API v3 endpoints.

./gradlew build
cd examples
touch Example.java

Add the example you want to test to Example.java, including the headers at the top of the file.

javac -classpath ../repo/com/sendgrid/4.4.1/sendgrid-4.4.1-jar.jar:. Example.java && java -classpath ../repo/com/sendgrid/4.4.1/sendgrid-4.4.1-jar.jar:. Example

Understanding the Code Base

/examples

Working examples that demonstrate usage.

/src/test

Unit and integration tests.

/src/main

The interface to the Twilio SendGrid API.

Testing

All PRs require passing tests before the PR will be reviewed.

All test files are in the tests directory.

For the purposes of contributing to this repo, please update the SendGridTest.java file with unit tests as you modify the code.

  1. Download prism for your platform (Mac OS X, Linux, Windows) and save the binary to the sendgrid-java directory (or any directory you would like. The sendgrid-java directory is chosen mostly for convenience.)

  2. Add execute permissions

    chmod +x prism

  3. In a separate terminal, cd into the directory you chose for prism and start the sendgrid local server which the tests will use.

    ./prism run --mock --list --spec https://raw.githubusercontent.com/sendgrid/sendgrid-oai/master/oai_stoplight.json

  4. Now you can run the test suite from the root of the project

    ./gradlew test -i

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/sendgrid-java

# Navigate to the newly cloned directory
cd sendgrid-java

# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/sendgrid/sendgrid-java

  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> development

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

If you have any additional questions, please feel free to email us or create an issue in this repo.