Link Search Menu Expand Document

Developer Information

The pages here are intended for developers who are making or maintaining a package, especially one that is part of Scikit-HEP or being proposed to become part.

New developers are encouraged to read the following pages. Veteran developers should still check out introduction, as it has a guide on recommendations for your CONTRIBUTING.md.

Following that, there are recommendations for style, intended to promote good practices and to ensure continuity across the packages. There is then a guide on packaging, which should help in ensuring a consistent developer and user experience when working with distribution.

A section on CI follows, with a general setup guide, and then two choices for using CI to distribute your package, on for pure Python, and one for compiled extensions.

Finally, there are badge recommendations for your readme, including the Scikit-HEP badge!

Once you have completed the guidelines, there is a cookiecutter project, Scikit-HEP/cookie, that implements these guidelines and lets you setup a new package from a template in less than 60 seconds!


Table of contents