CONTRIBUTING.md

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.

• Improvements to the Codebase
• Understanding the Code Base
• Testing
• Style Guidelines & Naming Conventions
• Creating a Pull Request
• Code Reviews

Improvements to the Codebase

We welcome direct contributions to the smtpapi-nodejs code base. Thank you!

Development Environment

Install and Run Locally

Prerequisites

• Node.js version 0.10, 0.12 or 4
• The SendGrid Service, starting at the free level
• Please see package.json

Initial setup:

git clone https://github.com/sendgrid/smtpapi-nodejs.git
cd smtpapi-nodejs
npm install

Environment Variables

First, get your free SendGrid account here.

Next, update your environment with your SENDGRID_API_KEY.

echo "export SENDGRID_USERNAME='YOUR_USERNAME'" > sendgrid.env
echo "export SENDGRID_PASSWORD='YOUR_PASSWORD'" >> sendgrid.env
echo "sendgrid.env" >> .gitignore
source ./sendgrid.env

Execute:

See the examples folder to get started quickly.

To run the example (after updating the settings and the emails):

node examples/example.js

Understanding the Code Base

/examples

Working examples that demonstrate usage.

/test

Unit tests.

/lib

Source code.

Testing

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

All test files are in the test directory.

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

To run the tests:

npm test

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.

• Unofficial Style Guide

Please run your code through:

• ESLint with the standard style guide.
• esdoc to check the documentation coverage of your added code.

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

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