Skip to content

Latest commit

 

History

History
153 lines (101 loc) · 4.81 KB

CONTRIBUTING.md

File metadata and controls

153 lines (101 loc) · 4.81 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 simply ask that you follow the following contribution policies.

Improvements to the Codebase

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

Development Environment

Install and Run Locally

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

See the examples folder to get started quickly.

You will need to setup the following environment to use the SendGrid example:

echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
echo "sendgrid.env" >> .gitignore
source ./sendgrid.env
./gradlew build
cd examples
javac -classpath {path_to}/sendgrid-java-http-client-4.2.0-jar.jar:. Example.java && java -classpath {path_to}/sendgrid-java-http-client-4.2.0-jar.jar:. Example

Understanding the Code Base

/examples

Working examples that demonstrate usage.

Client.java

The main function that does the heavy lifting (and external entry point) is api.

Method.java

These are the supported Methods.

Request.java

Provides a standard interface to an API's HTTP request.

Response.java

Provides a standard interface to an API's response.

Testing

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

All test files are in java-http-client/src/test/java/com/sendgrid.

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

Run the tests:

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

  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.