Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Move Gate Decomposition Figures to Markdown Documentation

オープン
#190 コメント 1 件 リアクション 0 件 担当者 1 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@vinayswamik がすでに取り組んでいます。

2025年7月24日 から。

  • #237 @vinayswamik による — マージされずにクローズ

評価

この issue はまだ評価されていません。

説明

documentation good first issue no-qc-knowledge-reqd

Description

Refactor the gates.py file by relocating all gate decomposition figures (currently included as ASCII diagrams or docstring illustrations) into a dedicated Markdown documentation file (e.g., docs/gate_decompositions.md). The gates.py file will then reference the Markdown file, rather than embedding decomposition figures directly in code or docstrings.

Implementation

  • Extraction: Identify and extract all gate decomposition figures, ASCII diagrams, and explanatory illustrations from gates.py.
  • Documentation: Create a new Markdown file (e.g., docs/gate_decompositions.md) and organize the decompositions by gate name/type, preserving all relevant explanations and diagrams.
  • Reference Update: In gates.py, replace each removed figure with a reference or link to the corresponding section in the Markdown file. For example:
# See docs/gate_decompositions.md#crx-gate for decomposition details.
  • README Update: Optionally, add a reference to the new documentation file in the project README and relevant configs.
  • Testing: Ensure that docstring removals do not affect code execution or automated documentation builds.
主要言語
Python
スター
29
フォーク
33
平均マージ
2日 4時間
マージ済み PR(30日)
15

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

qBraid/pyqasm のほかの issue

qBraid/pyqasm の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。