Conforms to SendGrid's open source policies

thinkingserious · thinkingserious · commit ec13cc7c2ab4 · 2016-05-21T20:39:33.000-07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,6 @@
 # Change Log
 All notable changes to this project will be documented in this file.
+
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [1.0.1] - 2016-04-08
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,14 +1,28 @@
-Hello! Thank you for choosing to help contribute to the nodejs-http-client project. There are many ways you can contribute and help is always welcome.
-
+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.
+
+- [CLAs and CCLAs](#cla)
+- [Roadmap & Milestones](#roadmap)
+- [Feature Request](#feature_request)
+- [Submit a Bug Report](#submit_a_bug_report)
+- [Improvements to the Codebase](#improvements_to_the_codebase)
+- [Understanding the Code Base](#understanding_the_codebase)
+- [Testing](#testing)
+- [Style Guidelines & Naming Conventions](#style_guidelines_and_naming_conventions)
+- [Creating a Pull Request](#creating_a_pull_request)
+
+<a name="roadmap"></a>
 We use [Milestones](https://github.com/sendgrid/nodejs-http-client/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](#feature_request)
-* [Submit a Bug Report](#submit_a_bug_report)
-* [Improvements to the Codebase](#improvements_to_the_codebase)
-* [Understanding the Code Base](#understanding_the_codebase)
-* [Testing](#testing)
-* [Style Guidelines & Naming Conventions](#style_guidelines_and_naming_conventions)
-* [Creating a Pull Request](#creating_a_pull_request)
+<a name="cla"></a>
+## CLAs and CCLAs
+
+Before you get started, SendGrid requires that a SendGrid Contributor License Agreement (CLA) or a SendGrid Company Contributor Licensing Agreement (CCLA) be filled out by every contributor to a SendGrid open source project.
+
+Our goal with the CLA and CCLA is to clarify the rights of our contributors and reduce other risks arising from inappropriate contributions.  The CLA also clarifies the rights SendGrid holds in each contribution and helps to avoid misunderstandings over what rights each contributor is required to grant to SendGrid when making a contribution.  In this way the CLA and CCLA encourage broad participation by our open source community and help us build strong open source projects, free from any individual contributor withholding or revoking rights to any contribution.
+
+SendGrid does not merge a pull request made against a SendGrid open source project until that pull request is associated with a signed CLA (or CCLA). Copies of the CLA and CCLA are available [here](https://drive.google.com/a/sendgrid.com/file/d/0B0PlcM9qA91LN2VEUTJWU2RIVXc/view).
+
+You may submit your completed [CLA or CCLA](https://drive.google.com/a/sendgrid.com/file/d/0B0PlcM9qA91LN2VEUTJWU2RIVXc/view) to SendGrid at [dx@sendgrid.com](mailto:dx@sendgrid.com).  SendGrid will then confirm you are ready to begin making contributions.
 
 There are a few ways to contribute, which we'll enumerate below:
 
@@ -37,49 +51,28 @@ Before you decide to create a new issue, please try the following:
 
 ### Please use our Bug Report Template
 
-In order to make the process easier, we've included a sample bug report template (borrowed from [Ghost](https://github.com/TryGhost/Ghost/)). The template uses [GitHub flavored markdown](https://help.github.com/articles/github-flavored-markdown/) for formatting.
-
-```
-Short and descriptive example bug report title
-
-#### Issue Summary
-
-A summary of the issue and the environment in which it occurs. If suitable, include the steps required to reproduce the bug. Please feel free to include screenshots, screencasts, code examples.
-
-
-#### Steps to Reproduce
-
-1. This is the first step
-2. This is the second step
-3. Further steps, etc.
-
-Any other information you want to share that is relevant to the issue being reported. Especially, why do you consider this to be a bug? What do you expect to happen instead?
-
-#### Technical details:
-
-* node-http-client Version: master (latest commit: [commit number])
-* Node.js Version: 4.1.2
-```
+In order to make the process easier, we've included a [sample bug report template](https://github.com/sendgrid/nodejs-http-client/.github/ISSUE_TEMPLATE) (borrowed from [Ghost](https://github.com/TryGhost/Ghost/)). The template uses [GitHub flavored markdown](https://help.github.com/articles/github-flavored-markdown/) for formatting.
 
 <a name="improvements_to_the_codebase"></a>
 ## Improvements to the Codebase
 
-We welcome direct contributions to the rest code base. Thank you!
+We welcome direct contributions to the nodejs-http-client code base. Thank you!
 
 ### Development Environment ###
 
-#### Install and run locally ####
+#### Install and Run Locally ####
 
 ##### Prerequisites #####
 
-* Node.js 0.10 and up
-* Please see [package.json](https://github.com/sendgrid/nodejs-http-client/blob/master/package.json)
+- Node.js 0.10 and up
+- Please see [package.json](https://github.com/sendgrid/nodejs-http-client/blob/master/package.json)
 
 ##### Initial setup: #####
 
-```
+```bash
 git clone https://github.com/sendgrid/nodejs-http-client.git
 cd nodejs-http-client
+npm install
 ```
 
 ##### Execute: #####
@@ -88,13 +81,19 @@ See the [examples folder](https://github.com/sendgrid/nodejs-http-client/tree/ma
 
 You will need to setup the following environment to use the SendGrid example:
 
-```
+```bash
 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:
+
+```bash
+node ./examples/example.js
+```
+
 <a name="understanding_the_codebase"></a>
 ## Understanding the Code Base
 
@@ -104,7 +103,7 @@ Working examples that demonstrate usage.
 
 **client.js**
 
-There is a object to hold both the request and response to the API server. 
+There is a 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`.
 
@@ -113,7 +112,7 @@ The main function that does the heavy lifting (and external entry point) is `API
 
 All PRs require passing tests before the PR will be reviewed.
 
-All test files are in `[test/test.js](https://github.com/sendgrid/nodejs-http-client/blob/master/test/test.js)`.
+All test files are in [`test/test.js`](https://github.com/sendgrid/nodejs-http-client/blob/master/test/test.js).
 
 For the purposes of contributing to this repo, please update the [`test.js`](https://github.com/sendgrid/nodejs-http-client/blob/master/test/test.js) file with unit tests as you modify the code.
 
@@ -126,15 +125,11 @@ Run the test:
 
 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](https://github.com/felixge/node-style-guide)
-
-Please run your code through [ESLint](http://eslint.org/) Standard style guide.
+- [Unofficial Style Guide](https://github.com/felixge/node-style-guide)
 
-### Directory Structure
+Please run your code through:
 
-* `examples` for example calls
-* `lib` for the main source code
-* `test` for the unit tests
+- [ESLint](http://eslint.org/) with the standard style guide.
 
 ## Creating a Pull Request<a name="creating_a_pull_request"></a>
 
@@ -145,7 +140,7 @@ Please run your code through [ESLint](http://eslint.org/) Standard style guide.
    # 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
+   cd sendgrid-python
    # Assign the original repo to a remote called "upstream"
    git remote add upstream https://github.com/sendgrid/nodejs-http-client
    ```
@@ -189,4 +184,4 @@ Please run your code through [ESLint](http://eslint.org/) Standard style guide.
 7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
     with a clear title and description against the `master` branch. All tests must be passing before we will review the PR.
 
-If you have any additional questions, please feel free to [email](mailto:dx@sendgrid.com) us or create an issue in this repo.
+If you have any additional questions, please feel free to [email](mailto:dx@sendgrid.com) us or create an issue in this repo.
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 SendGrid
+Copyright (c) 2016 SendGrid, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -2,7 +2,17 @@
 
 **HTTP REST client, simplified for Node.js**
 
-Here is a quick example:
+# Announcements
+
+All updates to this library is documented in our [CHANGELOG](https://github.com/sendgrid/nodejs-http-client/blob/master/CHANGELOG.md).
+
+# Installation
+
+```bash
+npm install sendgrid-rest
+```
+
+# Quick Start
 
 `GET /your/api/{param}/call`
 
@@ -49,11 +59,7 @@ client.API(request, function (response) {
 })
 ```
 
-# Installation
-
-`npm install sendgrid-rest`
-
-## Usage ##
+# Usage
 
 Following is an example using SendGrid. You can get your free account [here](https://sendgrid.com/free?source=nodejs-http-client).
 
@@ -65,109 +71,19 @@ echo "sendgrid.env" >> .gitignore
 source ./sendgrid.env
 ```
 
-Following is an abridged example, here is the [full working code](https://github.com/sendgrid/nodejs-http-client/blob/master/examples/example.js).
+Here is the [full working code](https://github.com/sendgrid/nodejs-http-client/blob/master/examples/example.js).
+
+To run the example:
 
 ```bash
 node examples/example
 ```
 
-```javascript
-var Client = require('sendgrid-rest').Client
-var emptyRequest = require('sendgrid-rest').request
-
-// These values persist across of subsequent calls, unless overidden.
-var globalRequest = JSON.parse(JSON.stringify(emptyRequest))
-globalRequest.host = 'api.sendgrid.com';
-globalRequest.headers['Content-Type'] = 'application/json'
-// You must add your SendGrid API Key to your OS Environment
-globalRequest.headers['Authorization'] = 'Bearer '.concat(process.env.SENDGRID_API_KEY)
-var client = new Client(globalRequest)
-
-// GET Collection
-var requestGet = JSON.parse(JSON.stringify(emptyRequest))
-requestGet.method = 'GET'
-requestGet.path = '/v3/api_keys'
-requestGet.queryParams['limit'] = 100
-requestGet.queryParams['offset'] = 0
-client.API(requestGet, function (response) {
-})
-
-// POST
-var requestBody = {
-  'name': 'My API Key from Node.js',
-  'scopes': [
-    'mail.send',
-    'alerts.create',
-    'alerts.read'
-  ]
-}
-var requestPost = JSON.parse(JSON.stringify(emptyRequest));
-requestPost.method = 'POST'
-requestPost.path = '/v3/api_keys'
-requestPost.requestBody = requestBody
-requestPost.headers['X-Test'] = 'test'
-function createAPIKey (callback) {
-  client.API(requestPost, function (response) {
-    var body = JSON.parse(response.responseBody)
-    callback(body.api_key_id)
-  })
-}
-
-createAPIKey(function (returnValue) { // This ensures we POST a new key first, to get the api_key_id
-  var api_key_id = '/'.concat(returnValue)
-
-  // GET SINGLE
-  var requestGetSingle = JSON.parse(JSON.stringify(emptyRequest))
-  requestGetSingle.method = 'GET'
-  requestGetSingle.path = '/v3/api_keys'.concat(api_key_id)
-  client.API(requestGetSingle, function (response) {
-  })
-
-  // PATCH
-  requestBody = {
-    'name': 'A New Hope'
-  }
-  var requestPatch = JSON.parse(JSON.stringify(emptyRequest))
-  requestPatch.method = 'PATCH'
-  requestPatch.path = '/v3/api_keys'.concat(api_key_id)
-  requestPatch.requestBody = requestBody
-  client.API(requestPatch, function (response) {
-  })
-
-  // PUT
-  requestBody = {
-    'name': 'A New Hope',
-    'scopes': [
-      'user.profile.read',
-      'user.profile.update'
-    ]
-  }
-  var requestPut = JSON.parse(JSON.stringify(emptyRequest))
-  requestPut.method = 'PUT'
-  requestPut.path = '/v3/api_keys'.concat(api_key_id)
-  requestPut.requestBody = requestBody
-  client.API(requestPut, function (response) {
-  })
-
-  // DELETE
-  var requestDelete = JSON.parse(JSON.stringify(emptyRequest))
-  requestDelete.method = 'DELETE'
-  requestDelete.path = '/v3/api_keys'.concat(api_key_id)
-  client.API(requestDelete, function (response) {
-  })
-})
-
-```
-
-# Announcements
-
-[2016.04.08] - We hit version 1!
-
-# Roadmap
+## Roadmap
 
-[Milestones](https://github.com/sendgrid/nodejs-http-client/milestones)
+If you are intersted in the future direction of this project, please take a look at our [milestones](https://github.com/sendgrid/nodejs-http-client/milestones). We would love to hear your feedback.
 
-# How to Contribute
+## How to Contribute
 
 We encourage contribution to our libraries, please see our [CONTRIBUTING](https://github.com/sendgrid/nodejs-http-client/blob/master/CONTRIBUTING.md) guide for details.
 
@@ -177,9 +93,9 @@ We encourage contribution to our libraries, please see our [CONTRIBUTING](https:
 
 # About
 
-![SendGrid Logo]
-(https://assets3.sendgrid.com/mkt/assets/logos_brands/small/sglogo_2015_blue-9c87423c2ff2ff393ebce1ab3bd018a4.png)
-
 nodejs-http-client is guided and supported by the SendGrid [Developer Experience Team](mailto:dx@sendgrid.com).
 
 nodejs-http-client is maintained and funded by SendGrid, Inc. The names and logos for nodejs-http-client are trademarks of SendGrid, Inc.
+
+![SendGrid Logo]
+(https://assets3.sendgrid.com/mkt/assets/logos_brands/small/sglogo_2015_blue-9c87423c2ff2ff393ebce1ab3bd018a4.png)
