tensorflow / tensorflow/quantum
Improve version numbering for development releases
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.2k
- Forks
- 665
- PR merge metrics
- No merged PRs in 30d
Description
Multiple people have expressed confusion about the way version numbering is done in TensorFlow Quantum. In particular, the version in the main branch on GitHub is our active development version, but the form of the version number is not well-enough differentiated from the form of version numbers used in releases. For example, the current released version on PyPI is 0.7.6 and the current version in main is 0.7.7. Many other projects (including most of our other QAI projects) follow a practice of adding a suffix like .dev0 to make it clear it is a development version. We should adopt a similar practice here.
The Python packaging guide page on versioning provides some more examples and recommendations.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating where TensorFlow Quantum declares its version and how packaging builds it; compare the main-branch value with the PyPI 0.7.6 release and consult the Python packaging guide linked in the issue. Done means development builds use a clearly differentiated suffix such as .dev0 while released version semantics remain unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, release
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100