sphinx-contrib / sphinx-contrib/autoprogram

Document Python version compatibility expectations

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

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
48
Forks
24
Avg merge
2h 15m
Merged PRs (30d)
1

Description

As highlighted in #42, the expectations around what versions of Python this project supports are unclear. These should be documented, and every supported version should be tested in CI.

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 issue #42 and the repository’s CI configuration to find the existing Python-version assumptions and test setup. Document the supported Python versions and update CI so every supported version is tested; done means the compatibility expectations and CI coverage agree.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
ci-cd, documentation, testing-qa
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.