Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
lwasser opened this issue Jul 4, 2024 · 0 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed sprintable

Comments

@lwasser
Copy link
Member

lwasser commented Jul 4, 2024

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.

@lwasser lwasser added help wanted Extra attention is needed sprintable labels Jul 4, 2024
@lwasser lwasser changed the title Add DEVELOPMENT documentation for creating a release. [pyosmeta] Add DEVELOPMENT documentation for creating a release for our pyosMeta package. Jul 12, 2024
@lwasser lwasser added the good first issue Good for newcomers label Jul 12, 2024
@lwasser lwasser changed the title [pyosmeta] Add DEVELOPMENT documentation for creating a release for our pyosMeta package. [pyosmeta] Add DEVELOPMENT documentation for development and release for our pyosMeta package. Jul 12, 2024
@lwasser lwasser changed the title [pyosmeta] Add DEVELOPMENT documentation for development and release for our pyosMeta package. [pyosmeta] Add DEVELOPMENT documentation for development and release for the pyosMeta package. Jul 12, 2024
@lwasser lwasser changed the title [pyosmeta] Add DEVELOPMENT documentation for development and release for the pyosMeta package. [pyosmeta] Add DEVELOPMENT documentation for development and release for the pyosMeta package. (supports peer review metadata) Jul 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed sprintable
Projects
Status: python programming
Development

No branches or pull requests

1 participant