pcdshub / pcdshub/pcds-python-migration-tools

PyPI uploads can break if content type not set on long description (README)

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

Nobody has claimed this yet.

Dominant language
Python
Stars
0
Forks
2
PR merge metrics
No merged PRs in 30d

Description

The migration tool should check the readme extension and set content-type appropriately:

[tool.setuptools.dynamic.readme]
file = "README.md"
content-type = "text/markdown"

ref: https://github.com/pypa/setuptools/issues/3735

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 reading the referenced setuptools issue and locating the migration tool's README handling. Check how README.md and other extensions are converted, then verify that the generated configuration sets the matching content-type, including text/markdown for README.md.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.