docs: document PR stacking workflow and branch naming - #191
Open
laserkelvin wants to merge 2 commits into
Open
Conversation
Add a stacking bullet to AGENTS.md using the `<github handle>/<shared-stack-topic>/<layer>` branch scheme, and a "Stacking Pull Requests" section to CONTRIBUTING.md covering the same-repository requirement and the two supported workflows: the `gh stack` commands in GitHub CLI and the GitHub website. Signed-off-by: Kelvin Lee <kinlongkelvi@nvidia.com>
Contributor
 The documentation-only PR appears safe to merge. Findings
Summary
Reviews (2) · Last reviewed commit: "docs: note gh-stack extension prerequisi..." |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
|
|
||
| There are two ways to build a stack, both documented by GitHub: | ||
|
|
||
| - With the `gh stack` commands in GitHub CLI (see the |
Contributor
There was a problem hiding this comment.
The workflow begins with gh stack init, but stack is not included in the standard GitHub CLI. Contributors must first install the github/gh-stack extension; otherwise, these commands fail as unknown. Please document gh extension install github/gh-stack before this workflow and add the same prerequisite to the corresponding AGENTS.md guidance.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
The `gh stack` commands ship as the `github/gh-stack` GitHub CLI extension rather than built-in commands; note the conditional install step in both AGENTS.md and CONTRIBUTING.md. Addresses Greptile review feedback. Signed-off-by: Kelvin Lee <kinlongkelvi@nvidia.com>
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
1 participant
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.
ALCHEMI Toolkit Pull Request
Description
Documents the repository's PR stacking workflow for both human contributors and coding agents.
Type of Change
Related Issues
N/A
Changes Made
AGENTS.md: agents stacking PRs should name branches<github handle>/<shared-stack-topic>/<layer>and may use either thegh stackcommands in GitHub CLI or the GitHub website.CONTRIBUTING.md: new "Stacking Pull Requests" section covering the same-repository requirement (cross-fork stacks are not supported), the branch naming scheme, both workflows, merge/retarget behavior, and links to GitHub's stacked PR documentation.Testing
Documentation-only change; verified with
markdownlintthrough the pre-commit hooks.make pytest)make lint)Checklist
Additional Notes
CHANGELOG.mdintentionally not updated: this is contributor-process documentation, not a package change.Tip
This repository uses Greptile, an AI code review service, to help conduct
pull request reviews. We encourage contributors to read and consider suggestions
made by Greptile, but note that human maintainers will provide the necessary
reviews for merging: Greptile's comments are not a qualitative judgement
of your code, nor is it an indication that the PR will be accepted/rejected.
We encourage the use of emoji reactions to Greptile comments, depending on
their usefulness and accuracy.