microsoft / microsoft/Qcodes

Broken link in documentation

Open Beginner friendly
#1,087 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
459
Forks
359
Avg merge
3d 6h
Merged PRs (30d)
73

Description

In the docs, at the setup section of the community guide, the link to the README page detailing how to set the development environment up is broken.

Steps to reproduce
  1. Go to http://qcodes.github.io/Qcodes/community/contributing.html#setup
  2. Click on the README link
System

Windows 10 Entreprise

master

a3fbf6e01817e5460c2ac0246c8e8e7d7db75967

Contributor guide

Open the contributing guide

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

Open the community guide at the setup section and inspect the README link described in the issue. Replace the broken target with the correct README destination, then verify that the link opens successfully from the published setup section.

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
Clearly specified
Newbie friendliness
75/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.