Qiskit / Qiskit/documentation

Update README to talk about the `./setup` script

Open
#4,385 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

infra 🏗️
Dominant language
Jupyter Notebook
Stars
106
Forks
223
Avg merge
1d 8h
Merged PRs (30d)
72

Description

Simplify our instructions.

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 opening the repository README and inspecting the ./setup script. Revise the README's setup instructions to explain the script, using the script and existing instructions to determine the relevant details. The work is done when a reader can understand how and why to use ./setup.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.