Merge pull request #454 from petl-developers/contributing-20180803

DOC: information re contributing

.github/CONTRIBUTING.md

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

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,37 @@
+<!--
+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 ``petl.__version__``
+* Version information for any third-party package dependencies that are relevant
+* Version of Python interpreter
+* Operating system (Linux/Windows/Mac)
+* How petl 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 petl.
+
+Thanks!
+-->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+<!--
+Description of PR
+-->
+
+<!--
+Checklist for for pull requests including new code and/or changes to existing code...
+-->
+
+* [ ] Includes unit tests
+* [ ] New functions have docstrings with examples that can be run with doctest
+* [ ] New functions are included in API docs
+* [ ] Docstrings include notes for any changes to API or behaviour
+* [ ] Travis CI passes (unit tests run under Linux)
+* [ ] AppVeyor CI passes (unit tests run under Windows)
+* [ ] Unit test coverage has not decreased (see Coveralls)
+* [ ] All changes documented in docs/changes.rst

docs/contributing.rst

@@ -111,3 +111,20 @@ If you are able, please run tox and ensure that all the above tests pass
 before making a pull request.
 
 Thanks!
+
+Guidelines for core developers
+------------------------------
+
+Before merging a pull request that includes new or modified code, all
+items in the `PR checklist <https://github.com/petl-developers/petl/blob/master/.github/PULL_REQUEST_TEMPLATE.md>`_
+should be complete.
+
+Pull requests containing new and/or modified code that is anything
+other than a trivial bug fix should be approved by at least one core
+developer before being merged. If a core developer is making a PR
+themselves, it is OK to merge their own PR if they first allow some
+reasonable time (e.g., at least one working day) for other core devs
+to raise any objections, e.g., by posting a comment like "merging soon
+if no objections" on the PR. If the PR contains substantial new
+features or modifications, the PR author might want to allow a little
+more time to ensure other core devs have an opportunity to see it.

docs/intro.rst

@@ -21,8 +21,8 @@ To verify the installation, the test suite can be run with `nose
     $ pip install nose
     $ nosetests -v petl
 
-:mod:`petl` is compatible with Python versions 2.7 and 3.4, and
-has been tested under Linux and Windows operating systems.
+:mod:`petl` has been tested with Python versions 2.7 and 3.4-3.6 
+under Linux and Windows operating systems.
 
 .. _intro_dependencies:
 

tox.ini

@@ -9,8 +9,8 @@
 envlist = py34,{py27,py35,py36}-optional, docs, lxml
 # trick to enable pre-installation of numpy and numexpr
 indexserver =
-    preinstall1 = https://pypi.python.org/pypi
-    preinstall2 = https://pypi.python.org/pypi
+    preinstall1 = https://pypi.org/simple
+    preinstall2 = https://pypi.org/simple
 
 [testenv]
 # get stable output for unordered types