search

scikit-hep / scikit-hep.github.io

Pages defining the website of the Scikit-HEP project.
https://scikit-hep.org
BSD 3-Clause "New" or "Revised" License
12 stars 15 forks source link

[addition] List common mistakes/antipatterns #86

Open henryiii opened 3 years ago

henryiii commented 3 years ago

We should list a few things that you should not do, like using setup.py directly, especially not setup.py test, which is discouraged and deprecated. Maybe include common mistakes, like accidentally included the "tests" folder in the install (or maybe even the SDist).

eduardo-rodrigues commented 2 years ago

Hi @henryiii, I wonder if this is not effectively done via all the developer pages you have prepared? If so, better close and "clean-up".

henryiii commented 2 years ago

This would be a developer pages addition with "antipatterns", which we don't have yet. Or maybe each page could end with antipatterns?

eduardo-rodrigues commented 2 years ago

I would actually go with antipatterns related that the various devel pages, yes. This way a person can see the examples while being made aware of what are bad practices. A single page may be too much of a mix and less clear in the end.