search

Qiskit / qiskit-tutorials

A collection of Jupyter notebooks showing how to use the Qiskit SDK
Apache License 2.0
2.31k stars 1.29k forks source link

Inconsistencies between contribution guidelines in README and PR template #1346

Closed Guillermo-Mijares-Vilarino closed 1 year ago

Guillermo-Mijares-Vilarino commented 2 years ago

Informations

What is the current behavior?

The contribution guidelines from the README are inconsistent with the PR template.

In particular, the PR template asks you to follow these steps:

✅ I have added the tests to cover my changes. ✅ I have updated the documentation accordingly.

However the README states that

In order for a tutorial to show up in the Qiskit documentation, after successful merging, an additional PR needs to be made in the Qiskit meta-repo to trigger the rebuilding of the documentation.

So you are not expected to update the documentation until AFTER your PR got approved but for the PR to be approved in the first place you are expected to have already updated the documentation.

And there is no mention of tests in the README or the contribution guidelines to which the README links you.

There isn't a test folder in the repo either. Which tests are we supposed to add?

Steps to reproduce the problem

What is the expected behavior?

Users can get confused when trying to do PRs so some of them may not upload valid and useful contributions to Qiskit.

Suggested solutions

Update PR template to reflect the qiskit-tutorials guidelines.

Eric-Arellano commented 1 year ago

Thanks! This repo is being archived very soon so we can ignore this.