docs: separate maintainer guidance from user docs#36
Draft
Conversation
There was a problem hiding this comment.
Pull request overview
Moves maintainer/developer workflow documentation out of the user-facing README into a dedicated DEVELOPMENT.md, keeping contribution guidance linked and easier to find.
Changes:
- Removed development/setup/testing content from
README.mdto keep it focused on install + usage. - Added
DEVELOPMENT.mdwith setup/build/test/lint/stubs instructions and LLVM upgrade checklist. - Updated
CONTRIBUTING.mdto point contributors toDEVELOPMENT.md(and removed redundant testing details).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| README.md | Removes maintainer guidance; adds pointer to DEVELOPMENT.md from Contributing section. |
| DEVELOPMENT.md | New maintainer/developer workflow doc (setup/build/test/LLVM upgrades). |
| CONTRIBUTING.md | Updates contributor onboarding link from README “Development” section to DEVELOPMENT.md. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+12
to
+15
| # Install LLVM 21 (macOS/Homebrew example) | ||
| brew install llvm@21 | ||
| export LLVM_SYS_211_PREFIX=/opt/homebrew/opt/llvm@21 | ||
|
|
There was a problem hiding this comment.
The Homebrew LLVM prefix shown here (/opt/homebrew/opt/llvm@21) is Apple Silicon–specific; on Intel macOS it is typically /usr/local/opt/llvm@21. Please either note both paths (or show a small conditional snippet like the one used in pyproject.toml) to avoid misleading setup instructions.
qartik
force-pushed
the
ks/qir2-maintenance
branch
2 times, most recently
from
b989e62 to
2417120
Compare
qartik
force-pushed
the
ks/qir2-maintenance
branch
from
2417120 to
08a3f88
Compare
qartik
force-pushed
the
ks/qir2-maintenance
branch
from
08a3f88 to
568f804
Compare
qartik
force-pushed
the
ks/qir2-maintenance
branch
2 times, most recently
from
8d7249b to
a24b2e1
Compare
qartik
force-pushed
the
ks/qir2-maintenance
branch
from
a24b2e1 to
c5019dd
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Move maintainer-oriented setup and workflow guidance out of the README and into DEVELOPMENT.md.
Included
Merge Order
main.