pylhe
pylhe copied to clipboard
scikit-hep
add CONTRIBUTING.md
@henryiii committed just yesterday a CONTRIBUTING file to https://github.com/scikit-hep/particle, with a format that is meant to be used by whoever wants to in Scikit-HEP, to have some uniformity. You could just use that and have this done in no time :-).
We might want to expand it a bit, but the important part is the link to the central location on the scikit-hep.org page, which we can update.
but the important part is the link to the central location on the scikit-hep.org page, which we can update.
Unless every Scikit-HEP library is going to have the same setup.py extras, shouldn't the CONTRIBUTING be tailored to each project? It make sense to have a template that we can all use, but having a single file for all projects seems like it would be problematic.
Maybe I misunderstood though. Are you just saying that we should all add the
See the Scikit-HEP Developer introduction for a detailed description of best practices for developing Scikit-HEP packages.
to the top of our CONTRIBUTING files?
I really think we should try to standardize on a minimal set of extras we include, like "all", "dev", and "test". But the single page is for more detailed but general setup, and the CONTRIBUTING template and any customizations (or a completely new file) is for the specifics of each project (like what extras are present, etc).
So yes, each CONTRIBUTING is expected to be different, and the template is a suggestion. However, they all should probably link to the general guidelines at the top, like that one.
Hello @amangoel185. If I'm not mistaken you have been updating several org packages with contributing files. Can you point me to a very recent example so that we add one CONTRIBUTING in here? Advance thanks.
Hi @eduardo-rodrigues, I haven't made one from scratch recently, but I like the ones present in uproot-browser and Hist.
The basic idea is to have something similar to what @henryiii and @matthewfeickert mentioned.
On the top:
See the Scikit-HEP Developer introduction for a detailed description of best practices for developing Scikit-HEP packages.
And then sections for Quick development, PyPI, Conda, Post setup, Testing, Pre-commit etc.
I also think that there were some advantages to having the CONTRIBUTING.md in the .github directory rather than root, @henryiii might know more!
