launchpad-reviewers team mailing list archive

[Jürgen Gmach <mp+416744@xxxxxxxxxxxxxxxxxx>]

> Should running the plain `tox` command run the unit tests twice - once each for the unit test environment and once for the coverage environment. 

Yes, this is a common approach.

Once we use 4, we can use a different approach. As then it is more easily possible to declare dependencies between environments, resp. run environments in succession.


Diff comments:

> diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
> index e4c23d1..64753c6 100644
> --- a/CONTRIBUTING.rst
> +++ b/CONTRIBUTING.rst
> @@ -6,8 +6,6 @@ Prerequisites
>  
>  * Python 3.8+
>  * `tox <https://tox.wiki/en/latest/>`_
> -* `pyenv <https://github.com/pyenv/pyenv>`_, if you want to use and test against
> -  multiple versions of Python

As I already mentioned several times - feel free to improve the documentation to fit your needs or the needs you think others have, but I have never seen such documentation in a Python project. I think it is natural to have one or several Python versions installed when you work on Python projects.

We have discussed this already on Mattermost. I think core devs need to have all Python versions installed, and test against all Python versions, and against all linters. For drive-by-contributors I do not care a lot whether they run linter or test against all Python versions. Having many contributions form external contributors is not that common for our projects - as least I cannot recall many in the last six months.

And actually - you added the `Python 3.8+` requirement - I would even prefer to remove it, see above reasons. As I Python dev, I usually have a look at the test setup (ie tox.ini) or the setup.py or other related versions to see which versions are supported - or at the trove classifier on PyPI - I think there is no need to duplicate that information in the developer documentation.

>  
>  Usage
>  -----


-- 
https://code.launchpad.net/~jugmac00/lpcraft/+git/lpcraft/+merge/416744
Your team Launchpad code reviewers is requested to review the proposed merge of ~jugmac00/lpcraft:improve-contribution-documentation into lpcraft:main.