Skip to content

[docs] Stress out the branch naming scheme for Graphite. #104499

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions llvm/docs/GitHub.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,23 @@ intended to be able to support "stacked" pull-request. Do not create any branche
llvm/llvm-project repository otherwise, please use a fork (see below). User branches that
aren't associated with a pull-request **will be deleted**.

Using Graphite for stacked Pull Requests
========================================

[Graphite](https://app.graphite.dev/) is a stacked pull request tool supported
by the LLVM repo (the other being [reviewable.io](https://reviewable.io)).

Graphite will want to create branches under `llvm/llvm-project` rather than your
private fork, so the guidance above, about branch naming, is critical, otherwise
`gt submit` (i.e. publish your PRs for review) will fail.

Use `gt config` then `Branch naming settings` and `Set a prefix for branch names`.
Include the last `/`.

If you didn't do the above and Graphite created non-prefixed branches, a simple way to
unblock is to rename (`git -m <old name> <new name>`), and then checkout the branch
and `gt track`.

Pull Requests
=============
The LLVM project is using GitHub Pull Requests for Code Reviews. This document
Expand Down
Loading