Skip to content
This repository has been archived by the owner on Aug 20, 2020. It is now read-only.

Latest commit

 

History

History
171 lines (112 loc) · 6.2 KB

CONTRIBUTING.md

File metadata and controls

171 lines (112 loc) · 6.2 KB
Raw

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.

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.

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.

Improvements to the Codebase

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

Development Environment

Install and Run Locally

Prerequisites
Initial setup:
git clone https://github.com/sendgrid/nodejs-http-client.git
cd nodejs-http-client
npm install
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
node examples/example.js

To run the example:

node ./examples/example.js

Understanding the Code Base

/examples

Working examples that demonstrate usage.

client.js

There is an object to hold both the request and response to the API server.

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

Testing

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

All test files are in test/test.js.

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

Run the test:

mocha

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

  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 master branch. All tests must be passing before we will review the PR.