version update and templates

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at brian.mcfee@nyu.edu. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,118 @@
+
+Contributing code
+=================
+
+How to contribute
+-----------------
+
+The preferred way to contribute to pumpp is to fork the 
+[main repository](http://github.com/bmcfee/pumpp/) on
+GitHub:
+
+1. Fork the [project repository](http://github.com/bmcfee/pumpp):
+   click on the 'Fork' button near the top of the page. This creates
+   a copy of the code under your account on the GitHub server.
+
+2. Clone this copy to your local disk:
+
+          $ git clone git@github.com:YourLogin/pumpp.git
+          $ cd pumpp
+
+3. Create a branch to hold your changes:
+
+          $ git checkout -b my-feature
+
+   and start making changes. Never work in the ``master`` branch!
+
+4. Work on this copy on your computer using Git to do the version
+   control. When you're done editing, do:
+
+          $ git add modified_files
+          $ git commit
+
+   to record your changes in Git, then push them to GitHub with:
+
+          $ git push -u origin my-feature
+
+Finally, go to the web page of the your fork of the pumpp repo,
+and click 'Pull request' to send your changes to the maintainers for
+review. This will send an email to the committers.
+
+(If any of the above seems like magic to you, then look up the 
+[Git documentation](http://git-scm.com/documentation) on the web.)
+
+It is recommended to check that your contribution complies with the
+following rules before submitting a pull request:
+
+-  All public methods should have informative docstrings with sample
+   usage presented.
+
+You can also check for common programming errors with the following
+tools:
+
+-  Code with good unittest coverage (at least 80%), check with:
+
+          $ pip install pytest pytest-cov
+          $ pytest
+
+-  No pyflakes warnings, check with:
+
+           $ pip install pyflakes
+           $ pyflakes path/to/module.py
+
+-  No PEP8 warnings, check with:
+
+           $ pip install pep8
+           $ pep8 path/to/module.py
+
+-  AutoPEP8 can help you fix some of the easy redundant errors:
+
+           $ pip install autopep8
+           $ autopep8 path/to/pep8.py
+
+Filing bugs
+-----------
+We use Github issues to track all bugs and feature requests; feel free to
+open an issue if you have found a bug or wish to see a feature implemented.
+
+It is recommended to check that your issue complies with the
+following rules before submitting:
+
+-  Verify that your issue is not being currently addressed by other
+   [issues](https://github.com/bmcfee/pumpp/issues?q=)
+   or [pull requests](https://github.com/bmcfee/pumpp/pulls?q=).
+
+-  Please ensure all code snippets and error messages are formatted in
+   appropriate code blocks.
+   See [Creating and highlighting code blocks](https://help.github.com/articles/creating-and-highlighting-code-blocks).
+
+-  Please include your operating system type and version number, as well
+   as your Python, scikit-learn, numpy, and scipy versions. This information
+   can be found by runnning the following code snippet:
+
+  ```python
+  import platform; print(platform.platform())
+  import sys; print("Python", sys.version)
+  import numpy; print("NumPy", numpy.__version__)
+  import scipy; print("SciPy", scipy.__version__)
+  import sklearn; print("sklearn", sklearn.__version__)
+  import librosa; print("librosa", librosa.__version__)
+  import jams; print("jams", jams.__version__)
+  import mir_eval; print("mir_eval", mir_eval.__version__)
+  ```
+
+Documentation
+-------------
+
+You can edit the documentation using any text editor and then generate
+the HTML output by typing ``make html`` from the docs/ directory.
+The resulting HTML files will be placed in _build/html/ and are viewable 
+in a web browser. See the README file in the doc/ directory for more information.
+
+For building the documentation, you will need 
+[sphinx](http://sphinx.pocoo.org/),
+[matplotlib](http://matplotlib.sourceforge.net/), and [numpydoc](https://pypi.python.org/pypi/numpydoc).
+
+Note
+----
+This document was gleefully borrowed from [scikit-learn](http://scikit-learn.org/).

ISSUE_TEMPLATE.md

@@ -0,0 +1,29 @@
+<!-- Instructions For Filing a Bug: https://github.com/bmcfee/pumpp/blob/master/CONTRIBUTING.md#filing-bugs -->
+
+#### Description
+<!-- Example: Error when computing spectral_contrast on a single frame-->
+
+#### Steps/Code to Reproduce
+<!--
+If the code is too long, feel free to put it in a public gist and link
+it in the issue: https://gist.github.com
+-->
+
+#### Expected Results
+<!-- Please describe what you expect your example code to do-->
+
+#### Actual Results
+<!-- Please paste or specifically describe the actual output or traceback. -->
+
+#### Versions
+<!--
+Please run the following snippet and paste the output below.
+import platform; print(platform.platform())
+import sys; print("Python", sys.version)
+import numpy; print("NumPy", numpy.__version__)
+import scipy; print("SciPy", scipy.__version__)
+import librosa; print("librosa", librosa.__version__)
+-->
+
+
+<!-- Thanks for contributing! -->

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+<!--
+Thanks for contributing a pull request! Please ensure you have taken a look at
+the contribution guidelines: https://github.com/bmcfee/pumpp/blob/master/CONTRIBUTING.md#how-to-contribute
+-->
+#### Reference Issue
+<!-- Example: Fixes #123 -->
+
+
+#### What does this implement/fix? Explain your changes.
+
+
+#### Any other comments?
+

pumpp/version.py

@@ -2,5 +2,5 @@
 # -*- coding: utf-8 -*-
 """Version info"""
 
-short_version = '0.2'
-version = '0.2.4'
+short_version = '0.3'
+version = '0.3.0pre'