riseproject-dev / riseproject-dev/python-wheels

docs: clean up field usage

Open
#386 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement good first issue infrastructure
Dominant language
Python
Stars
0
Forks
0
Avg merge
16h 14m
Merged PRs (30d)
952

Description

We currently have a mixture of several fields in our package docs. Between historic patterns and new workflows, each package may feature one or more of:

  1. comment - a generic field for providing commentary on a package. This was previously always used to provide a link to a GPL sources tarball if required for a package
  2. warning - usually used to indicate we've had to skip some sort of test or omit a piece of functionality in a module, due to incompatibility or known issues with riscv64 or our infrastructure
  3. patched - a typically blank field used to signal that the package is built with one or more patches applied during the process

These are all somewhat redundant. I propose two to replace these:

  1. gpl-sources - specify this with one or more links if we have to provide GPL source tarballs as part of the package builds
  2. comment - anything else (notes about patching, skipping tests, etc.) goes here

@justeph @luhenry thoughts?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue does not name specific files or tests; first locate the package documentation fields that currently use comment, warning, and patched. Confirm the proposed field scheme before migrating entries: use gpl-sources for GPL source links and comment for other notes, then verify no old field usage remains.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.