Skip to content

Latest commit

 

History

History
170 lines (113 loc) · 6.28 KB

CONTRIBUTING.md

File metadata and controls

170 lines (113 loc) · 6.28 KB
Raw

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.

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

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.10.3/sendgrid-4.10.3-jar.jar:. Example.java && java -classpath ../repo/com/sendgrid/4.10.3/sendgrid-4.10.3-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.

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

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

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