~javiljoen/lttb-numpy

f6bd8f449e7c1a49799c4c0dd2688f0167f0c363 — JA Viljoen 2 years ago cbe3c68
Move "Contributing" docs to separate file
2 files changed, 44 insertions(+), 35 deletions(-)

A CONTRIBUTING.rst
M README.rst
A CONTRIBUTING.rst => CONTRIBUTING.rst +41 -0
@@ 0,0 1,41 @@
Contributing
============

Reporting issues
----------------

If you find a bug or have an idea for improving this package,
please describe it in a ticket on the issue tracker.


Submitting patches
------------------

Patches are welcome.
Feel free to send them by email using `git send-email`,
or you can send me a link to your repo if it is publically accessible.

Please ensure that the tests and linting checks listed in the ``Makefile`` all pass,
and that any new features are covered by tests.


Development setup
-----------------

Create a Python virtual environment, e.g. using ``pyenv`` and/or ``direnv``.
In that venv, install the dependencies and development tools::

   pip install -r requirements.txt -r requirements-dev.txt
   pip install -e .

The linters and tests can then be run with the commands in the ``Makefile``::

   make lint
   make test

If you are using ``pyenv``, you can run the tests on multiple versions of Python.
Use ``pyenv`` to install pythons from the 2.7, 3.5, and 3.8 series;
then activate them in the project folder and run the tests with, e.g.::

   pyenv local 3.8.2 3.5.9 2.7.17
   make test-all

M README.rst => README.rst +3 -35
@@ 76,39 76,6 @@ by passing in a different list of validation functions, e.g.:
   small_data = lttb.downsample(data, n_out=20, validators=[has_two_columns, x_is_regular])


Contributing
============

If you find a bug or have an idea for improving this package,
please describe it in an *issue* on GitHub.

Patches are welcome and may be submitted as *pull requests* on GitHub.
They should pass the tests and linting checks listed in the ``Makefile``,
and any new features should be covered by tests.


Development setup
-----------------

Create a Python virtual environment, e.g. using ``pyenv`` and/or ``direnv``.
In that venv, install the dependencies and development tools::

   pip install -r requirements.txt -r requirements-dev.txt
   pip install -e .

The linters and tests can then be run with the commands in the ``Makefile``::

   make lint
   make test

If you are using ``pyenv``, you can run the tests on multiple versions of Python.
Use ``pyenv`` to install pythons from the 2.7, 3.5, and 3.8 series;
then activate them in the project folder and run the tests with, e.g.::

   pyenv local 3.8.2 3.5.9 2.7.17
   make test-all


History
=======



@@ 146,8 113,9 @@ History
Contributors
============

- Jack Viljoen (@javiljoen) – original Numpy implementation
- Guillaume Bethouart (@guillaumeB) – performance improvements
- JA Viljoen – original Numpy implementation
- Guillaume Bethouart – performance improvements
- Jens Krüger – fix for py27


.. |pypi| image:: https://img.shields.io/pypi/v/lttb?color=blue