riseproject-dev / riseproject-dev/python-wheels

docs: PRs should only specify the license, not extract from LICENSE files

Open
#385 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

Some upstream projects point at a license file with the license field in pyproject.toml. This causes our auto docs updates to pull in the entire license file's contents. This has not been a big issue since it isn't common, but it should be fixed so that the workflows/scripts only identify the correct license type and indicate it in the package's doc.

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

Start by locating the workflow or script responsible for automatic documentation updates and inspect how it reads the license field from pyproject.toml. Verify the change with a package whose license field points to a LICENSE file; done means the package documentation identifies the license type without including the full file contents.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.