search

Qiskit / qiskit-metapackage

Qiskit is an open-source SDK for working with quantum computers at the level of circuits, algorithms, and application modules.
https://qiskit.org
Apache License 2.0
3.03k stars 750 forks source link

Simplify "Contributing to Qiskit" #1667

Closed 1ucian0 closed 1 year ago

1ucian0 commented 1 year ago

Does existing documentation need to be updated with new content?

https://qiskit.org/documentation/contributing_to_qiskit.html

Currently, non-qiskit componentes are included in the guide. The references to qiskit-aer, platypus, qiskit-nature, qiskit-finance, qiskit-optimization, qiskit-machine-learning, qiskit-experiments, qiskit-dynamics, and qiskit-metal can be removed.

That will significantly simplify the page.

jakelishman commented 1 year ago

I'm not really sure I agree with this - I get that we want to promote "Qiskit == Terra", but this page was written before then, and its intent was to help discoverability for first-time contributors who wanted to help with the greater Qiskit community (or whatever we call what used to be Qiskit), but didn't even know what they could contribute to. Even if we make the naming split, I think this page of "how can I find something to contribute to?" is valuable. Even very long-term IBMers don't generally know every project in the flowchart, and it's segregated to help people with different skillsets find something.

People who already know enough to know the repository structure of Qiskit will (I'd think) still quickly find the CONTRIBUTING.md file in the repository they were interested in. The people I've heard complaining about this page aren't its target audience (although admittedly, I have a large selection bias in that I'm only likely to hear from those people, and not the actual target audience).