~javiljoen/lttb-numpy

lttb-numpy/CONTRIBUTING.rst -rw-r--r-- 1.4 KiB
9463159eJA Viljoen Remove builds.sr.ht script 1 year, 2 months ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Contributing
============

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

If you find a bug or have an idea for improving this package,
please describe it in a message to the mailing list: |mailinglist|.

.. |mailinglist| replace:: `~javiljoen/lttb-devel@lists.sr.ht <mailto:~javiljoen/lttb-devel@lists.sr.ht>`_


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

Patches are welcome.
Feel free to send them to |mailinglist| using ``git send-email``,
or you can send me a link to your repo if it is publically accessible.
If you prefer the pull request workflow,
you can also send me a PR at https://codeberg.org/javiljoen/lttb-numpy.

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.9 series;
then activate them in the project folder and run the tests with, e.g.::

   pyenv local 3.9.0 3.5.9 2.7.17
   make test-all