Closed edoaltamura closed 1 month ago
As a general comment you can see the existing sections followed the same pattern as Qiskit (same for the other applications and algorithms). In the past it was helpful since if needed/wanted any changes were similar across the set of repos. With the repos now under more individual maintainership having something different seems fine. As to sections like where to learn more and how to use - I would have thought tutorials and how to docs. Qiskit Nature started to add them in trying to do the docs more in the diataxis form, so the how to section would point to howtos when they existed. As to the Python support policy what versions have more come down to Qsikit since thats a key dependent. Once a version hits its support EOL then it does get dropped, it may take a while though for a new version to get supported based on how quickly all the key dependents support that new version.
Another couple of notes. One is that the sample code in the readme is extracted in one of the unit tests and run to make sure it stayed working. The other is that the content of the readme is embedded in the package that is published out on pypi (with the exception of some status items) so it shows up there too.
We could also add the following shields:
And finally the badge for https://www.bestpractices.dev/en/criteria/0
Issue https://github.com/qiskit-community/qiskit-machine-learning/issues/807 can be thought of as part of this README update.
Now that some of the README.md
is updated, the outstanding points to improve are:
What should we add?
Restructure the Readme file with a more structured introduction. Proposal: