microsoft/Quantum

"Intro to QSharp" samples

Open

#422 opened on Sep 1, 2020

View on GitHubContributor guide
 (2 comments) (2 reactions) (0 assignees)Jupyter Notebook (938 forks)auto 404
Kind-Enhancementgood first issue

Repository metrics

Stars
 (4,042 stars)
PR merge metrics
 (PR metrics pending)

Description

While the samples serve the purpose of demonstrating the usage of the language, it would be useful to have samples that explicitly demonstrate commonly used QSharp syntax, or even demonstrate more advanced syntax examples, without necessarily producing a useful algorithm. The goal is to make it easy for developers who learn by reading other code to pick up the language quickly.

Some examples:

  • within
  • Partial application
  • Adjoint, Controlled and is Adj + Ctl
  • ApplyToEach
  • Arrays, both 1D and 2D
  • Math, e.g. PowD

Based on contributor discussion.

Contributor guide

Research direction
Examine existing sample files in the repository to understand the pattern, then create new samples for each Q# syntax construct listed in the issue. Ensure code compiles and includes comments.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75