Merge pull request #2 from Netuitive/add-contributing

Add contributing

CONTRIBUTING.md

@@ -0,0 +1,69 @@
+Contributing to the Netuitive StatsD Server
+======================================
+Contributions are welcome and can be represented in many different ways as noted below. Help is greatly appreciated and credit will always be given.
+
+
+Types of Contributions
+------------------------------
+
+### Reporting Bugs
+Report bugs on [the issues page](https://github.com/Netuitive/netuitive-statsd/issues).
+With your bug report, please include:
+- Your operating system name and version.
+- Any details about your local setup that might be helpful in troubleshooting the issue.
+- Detailed steps to reproduce the bug.
+
+### Fixing bugs
+Find bugs at [the issues page](https://github.com/Netuitive/netuitive-statsd/issues). Anything tagged with
+"bug" is open to be fixed. 
+With your fix, please include:
+- The issue number
+- A detailed commit message
+
+### Implementing Features
+Find features at [the issues page](https://github.com/Netuitive/netuitive-statsd/issues). Anything tagged
+with "feature" is open to be implemented.
+With your feature, please include:
+- The issue number
+- A detailed commit message
+
+### Writing Documentation
+The Netuitive StatsD Server can always use documentation (more documentation is always better!). 
+Please document your features or usage as part of the official docs, in docstrings, 
+in blog posts, articles, or wherever you see fit.
+
+### Submitting Feedback
+File an issue at [the issues page](https://github.com/Netuitive/netuitive-statsd/issues).
+If you are proposing a feature:
+- Explain how it would work in detail
+- Keep the scope as narrow as possible to make it easier to implement
+
+Workflow
+------------------------------
+
+1. Create a branch directly in this repo or a fork (if you don't have push access). Please name
+branches within this repository `feature/<description>` or `fix/description`. For example, 
+something like `feature/upgrade_agent_0.2.3-70`.
+
+1. Create an issue or open a pull request (PR). If you aren't sure your PR will solve the issue
+or may be controversial, we're okay with you opening an issue separately and linking to it in 
+your PR. That way, if the PR is not accepted, the issue will remain and be tracked.
+
+1. Clone the fork/branch locally.
+
+1. Close (and reference) issues by the `closes #XXX` or `fixes #XXX` notation in the commit
+message. Please use a descriptive, useful commit message that could be used to understand why a
+particular change was made.
+
+1. Keep pushing commits to the initial branch using `--amend`/`--rebase` as necessary. Don't mix 
+unrelated issues in a single branch.
+
+1. Clean up the branch (rebase with master to synchronize, squash, edit commits, test, etc.) to
+prepare for it to be merged.
+
+1. If you didn't open a pull request already, do so now. 
+
+1. After reviewing your commits for documentation, passed continuous integration (CI) tests, 
+version bumps, changelogs, and good, descriptive commit messages, a project maintainer can merge your request.
+
+1. Create/update the changelog if necessary.

README.md

@@ -1,33 +1,27 @@
-Netuitive StatsD Server [![Build Status](https://travis-ci.org/Netuitive/netuitive-statsd.svg?branch=master)](https://travis-ci.org/Netuitive/netuitive-statsd) [![Coverage Status](https://coveralls.io/repos/github/Netuitive/netuitive-statsd/badge.svg?branch=master)](https://coveralls.io/github/Netuitive/netuitive-statsd?branch=master)
+Netuitive StatsD Server
 =======================
 
->**Note:** This is already installed as part of the Netuitive Linux Agent package and does not need to be installed separately.
+[![Build Status](https://travis-ci.org/Netuitive/netuitive-statsd.svg?branch=master)](https://travis-ci.org/Netuitive/netuitive-statsd) [![Coverage Status](https://coveralls.io/repos/github/Netuitive/netuitive-statsd/badge.svg?branch=master)](https://coveralls.io/github/Netuitive/netuitive-statsd?branch=master)
 
-Features
---------
+>**Note:** This is already installed as part of the [Netuitive Linux Agent](https://help.netuitive.com/Content/Misc/Datasources/Netuitive/new_netuitive_datasource.htm) package and does not need to be installed separately.
 
-* Interprets, aggregates, and forwards the follow formats to [Netuitive](http://www.netuitive.com/)
-    * StatsD
-    * DogStatsD Metrics
-    * DogStatsD Events
-    * DogStatsD Service Checks
-
-
-Usage
------
-See [USAGE.md](USAGE.md)
+The Netuitive StatsD Server interprets, aggregates, and forwards custom metrics generated from your application to [Netuitive](https://www.netuitive.com). Netuitive StatsD is compatible with the following formats: StatsD, DogStatsD Metrics, DogStatsD Events, and DogStatsD Service Checks. Using the values instrumented from your application's key actions and data (method calls, database queries, etc.), Netuitive aggregates the values, associates them with corresponding metrics, and analyzes them in our analytics cycles.
 
+For more information on the Netuitive StatsD Server, see our [help docs](https://help.netuitive.com/Content/Misc/Datasources/Netuitive/new_netuitive_datasource.htm#kanchor275), or contact Netuitive support at [support@netuitive.com](mailto:support@netuitive.com).
 
 Requirements
 ------------
 
 - Python >= 2.7 or >= 3.3
 - See [requirements.txt](requirements.txt) for Python modules
-- Working Netuitive Custom Datasource
+- Netuitive Linux Agent installed on your machine and setup in Netuitive
 
+Using the Netuitive StatsD Server
+----------------------------------
+See the [USAGE.md](USAGE.md).
 
-History
--------
+Additional Information
+----------------------
 
 See [HISTORY.md](HISTORY.md)