Skip to content

Latest commit

 

History

History
188 lines (130 loc) · 6.95 KB

CONTRIBUTING.md

File metadata and controls

188 lines (130 loc) · 6.95 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-nodejs code base. Thank you!

Development Environment

Install and Run Locally

Prerequisites
Initial setup:
git clone https://github.com/sendgrid/sendgrid-nodejs.git
cd sendgrid-nodejs
npm install

Environment Variables

First, get your free Twilio SendGrid account here.

You will need to setup the following environment to use the Twilio SendGrid examples in the README, USAGE and USE_CASES files:

echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
echo "sendgrid.env" >> .gitignore
source ./sendgrid.env
Execute:

To run an example:

touch example.js

Copy the desired code into example.js. For this example, I'm assuming you create this file in the root of this project.

Change the path to the Twilio SendGrid library to the relative path, for example: ./packages/mail/mail.

node example.js

Understanding the Code Base

This repo is organized as a monorepo with the packages residing in the ./packages directory. Please see the root README.md for details.

Codebase Overview

This repo is subdivided into 6 main packages. Each package has its dependencies (internal or external) and its source code in the src folder. Each package also has its isolated README files, use cases, and usage.md files.

To install a particular packages' dependencies.

cd packages/{NAME}
npm install or yarn install

Package List

1. Client This is a wrapper written on top of the request module to suite the Twilio SendGrid module. All requests made to the Twilio SendGrid API are invoked by the request function in the client.js.

Type declarations: client.d.ts Test Cases: client.spec.js

2. Mail This module exposes the send function which sends mail via the sdk. This module can be a good starting point to read the source code.

Type declarations: mail.d.ts Test Cases: mail.spec.js

3. Helpers These are a set of utility functions which all the modules use. Some of them are very basic functions and can be an easy starting point for reading the source code.

Testing

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

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:

  • ESLint with the standard style guide. 
    yarn lint
  • ESDoc to check the documentation coverage of your added code. 
    yarn doc

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

# Navigate to the newly cloned directory
cd sendgrid-nodejs

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

  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.

  5. Locally merge (or rebase) the upstream development branch into your topic branch:

    git pull [--rebase] upstream development

  6. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

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

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.