Skip to content

Commit 245cb1f

Browse files
committed
docs: Document procedure for updating pull requests
See discussion in #56637. Reviewed By: ldionne, jhenderson Differential Revision: https://reviews.llvm.org/D147284
1 parent afa607f commit 245cb1f

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

llvm/docs/GitHub.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,30 @@ is reserved for official project branches only. We may relax this rule in
1919
the future if needed to support "stacked" pull request, but in that case only
2020
branches being used for "stacked" pull requests will be allowed.
2121

22+
Pull Requests
23+
=============
24+
The LLVM Project does not currently accept pull requests for the llvm/llvm-project
25+
repository. However, there is a
26+
`plan <https://discourse.llvm.org/t/code-review-process-update/63964>`_ to move
27+
to pull requests in the future. This section documents the pull request
28+
policies LLVM will be adopting once the project starts using them.
29+
30+
Creating Pull Requests
31+
^^^^^^^^^^^^^^^^^^^^^^
32+
For pull requests, please push a branch to your fork of the llvm-project and
33+
`create a pull request from the fork <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork>`_.
34+
35+
Updating Pull Requests
36+
^^^^^^^^^^^^^^^^^^^^^^
37+
When updating a pull request, you should push additional "fix up" commits to
38+
your branch instead of force pushing. This makes it easier for GitHub to
39+
track the context of previous review comments.
40+
41+
If you do this, you must squash and merge before committing and
42+
you must use the pull request title and description as the commit message.
43+
The default commit message for a squashed pull request is the pull request
44+
description, so this will allow reviewers to review the commit message before
45+
approving the commit.
2246

2347
Releases
2448
========

0 commit comments

Comments
 (0)