Skip to content

docs: remove duplicate pass-proposal content from contributing guide - #713

Merged
bachase merged 2 commits into
unitaryfoundation:mainfrom
Asterisk-Hunter:docs/ucc-376-dedupe-proposing
Sep 25, 2026
Merged

bachase merged 2 commits into
unitaryfoundation:mainfrom
Asterisk-Hunter:docs/ucc-376-dedupe-proposing

Conversation

@Asterisk-Hunter

@Asterisk-Hunter Asterisk-Hunter commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Fixes #376

As suggested in #376, the "Proposing a New Compiler Pass" section of the contributing guide duplicated the content now living in the New Compiler Pass Proposal discussion template, risking the two drifting apart.

Changes

  • docs/source/contributing.rst: removed the duplicated checklist of what the proposal must contain and replaced it with the short wording proposed in Remove duplicate docs content on Proposing a new pass #376 ,an informal issue link for early ideas, and a link to the discussion template for formal proposals.
  • Updated the step-2 bullet that pointed at the removed checklist ("Use the test circuits defined in section 1…") to refer to the test circuits defined in the proposal itself, and dropped the now-unused hyperlink target.

Validation

  • uv sync --all-extras --all-groups
  • sphinx-build -M html docs/source — succeeds with no warnings
  • sphinx-build -M doctest docs/source -W --keep-going -n (mirrors CI) — 7 passed, 0 failures
  • pre-commit run --files docs/source/contributing.rst — passed

@bachase bachase left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this PR @Asterisk-Hunter . On small suggestion but otherwise looks good.

#. Estimate how much the technique is expected to reduce gate counts or compile time. This rough estimate helps us prioritize techniques.
#. Specify which types of circuits are expected to improve or not improve with this technique.
#. Define test circuits of the above types which you will use to validate the technique.
If you have an idea for a new compiler pass, please feel free to create an `issue <https://github.com/unitaryfoundation/ucc/issues/new/choose>`_.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider linking directly to the new pass issue template via /discussions/new?category=new-compiler-pass

@Asterisk-Hunter

Asterisk-Hunter commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor Author

@bachase Good catch!! updated in 2961240: the New Compiler Pass Proposal template link now points directly to discussions/new?category=new-compiler-pass (matching the existing links in user_guide.rst). Docs build passes.

@bachase
bachase merged commit a6c2878 into unitaryfoundation:main Sep 25, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove duplicate docs content on Proposing a new pass

2 participants