pyOpenSci / pyosMeta

A package that updates pyOpenSci contributor and package metadata on our website
BSD 3-Clause "New" or "Revised" License
4 stars 17 forks source link

[pyosmeta] Add DEVELOPMENT documentation for development and release for the pyosMeta package. (supports peer review metadata) #180

Open lwasser opened 1 month ago

lwasser commented 1 month ago

pyosMeta is a python package that we use to parse through our software peer review issues and create a "database" / yaml file of all of the packages that have been accepted to be shown on our website.

We really need more specific development documentation for this package to make it easier for people to contribute. Some of this might belong on our README page, other could be in a DEVELOPMENT.md file. Including:

  1. what this tool is for
  2. how it's used
  3. how we develop it.

I have created a similar page for stravalib here that we can reuse and just adjust (we use hatch and hatch_vcs here) instead of setuptools + setuptools_scm there. The workflows are similar so we can reuse work done on stravalib.