Merge pull request #227 from zarr-developers/contributing-20180103

Documentation about contributing

Author: alimanfoo

.github/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+Contributing
+============
+
+Please see the [project documentation](http://zarr.readthedocs.io/en/stable/contributing.html) for information about contributing to Zarr.
+

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,27 @@
+For bug reports, please follow the template below. For enhancement proposals, feel free
+to use whatever template makes sense.
+
+#### Minimal, reproducible code sample, a copy-pastable example if possible
+
+```python
+# Your code here
+
+```
+
+#### Problem description
+
+Explain why the current behavior is a problem, what the expected output/behaviour 
+is, and why the expected output/behaviour is a better solution.
+
+#### Version and installation information
+
+Please provide the following:
+
+* Value of ``zarr.__version__``
+* Value of ``numcodecs.__version__``
+* Version of Python interpreter
+* Operating system (Linux/Windows/Mac)
+* How Zarr was installed (e.g., "using pip into virtual environment", or "using conda")
+
+Also, if you think it might be relevant, please provide the output from ``pip freeze`` or
+``conda env export`` depending on which was used to install Zarr.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+[Description of PR]
+
+TODO:
+* [ ] Add unit tests and/or doctests in docstrings
+* [ ] Unit tests and doctests pass locally under Python 3.6 (e.g., run ``tox -e py36`` or 
+  ``pytest -v --doctest-modules zarr``)
+* [ ] Unit tests pass locally under Python 2.7 (e.g., run ``tox -e py27`` or
+  ``pytest -v zarr``)
+* [ ] PEP8 checks pass (e.g., run ``tox -e py36`` or ``flake8 --max-line-length=100 zarr``)
+* [ ] Add docstrings and API docs for any new/modified user-facing classes and functions
+* [ ] New/modified features documented in docs/tutorial.rst
+* [ ] Doctests in tutorial pass (e.g., run ``tox -e py36`` or ``python -m doctest -o NORMALIZE_WHITESPACE -o ELLIPSIS docs/tutorial.rst``)
+* [ ] Changes documented in docs/release.rst
+* [ ] Docs build locally (e.g., run ``tox -e docs``)
+* [ ] AppVeyor and Travis CI passes
+* [ ] Test coverage to 100% (Coveralls passes)

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Alistair Miles
+Copyright (c) 2015-2018 Zarr Developers <https://github.com/zarr-developers>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.rst

@@ -9,11 +9,11 @@ more information.
 .. image:: https://readthedocs.org/projects/zarr/badge/?version=latest
     :target: http://zarr.readthedocs.io/en/latest/?badge=latest
 
-.. image:: https://travis-ci.org/alimanfoo/zarr.svg?branch=master
-    :target: https://travis-ci.org/alimanfoo/zarr
+.. image:: https://travis-ci.org/zarr-developers/zarr.svg?branch=master
+    :target: https://travis-ci.org/zarr-developers/zarr
 
 .. image:: https://ci.appveyor.com/api/projects/status/7d4iko59k8hpbbik?svg=true
-    :target: https://ci.appveyor.com/project/alimanfoo/zarr
+    :target: https://ci.appveyor.com/project/zarr-developers/zarr
 
-.. image:: https://coveralls.io/repos/github/alimanfoo/zarr/badge.svg?branch=master
-    :target: https://coveralls.io/github/alimanfoo/zarr?branch=master
+.. image:: https://coveralls.io/repos/github/zarr-developers/zarr/badge.svg?branch=master
+    :target: https://coveralls.io/github/zarr-developers/zarr?branch=master

docs/conf.py

@@ -60,7 +60,7 @@ def __getattr__(cls, name):
 
 numpydoc_show_class_members = False
 numpydoc_class_members_toctree = False
-issues_github_path = 'alimanfoo/zarr'
+issues_github_path = 'zarr-developers/zarr'
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -78,8 +78,8 @@ def __getattr__(cls, name):
 
 # General information about the project.
 project = 'zarr'
-copyright = '2016, Alistair Miles'
-author = 'Alistair Miles'
+copyright = '2018, Zarr Developers'
+author = 'Zarr Developers'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -258,7 +258,7 @@ def __getattr__(cls, name):
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
     (master_doc, 'zarr.tex', 'zarr Documentation',
-     'Alistair Miles', 'manual'),
+     'Zarr Developers', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of