Lines Matching +full:- +full:- +full:pull
1 .. _github-reviews:
10 `Source Code <https://github.com/llvm/llvm-project>`_,
11 `Releases <https://github.com/llvm/llvm-project/releases>`_,
12 `Issue Tracking <https://github.com/llvm/llvm-project/issues>`_., and
13 `Code Reviews <https://github.com/llvm/llvm-project/pulls>`_.
22 intended to be able to support "stacked" pull-request. Do not create any branches in the
23 llvm/llvm-project repository otherwise, please use a fork (see below). User branches that
24 aren't associated with a pull-request **will be deleted**.
26 Using Graphite for stacked Pull Requests
29 `Graphite <https://app.graphite.dev/>`_ is a stacked pull request tool supported
32 Graphite will want to create branches under ``llvm/llvm-project`` rather than your
39 If you didn't do the above and Graphite created non-prefixed branches, a simple way to
40 unblock is to rename (``git -m <old name> <new name>``), and then checkout the branch
43 Pull Requests
45 The LLVM project is using GitHub Pull Requests for Code Reviews. This document
46 describes the typical workflow of creating a Pull Request and getting it reviewed
48 documentation refer to `GitHub's documentation <https://docs.github.com/pull-requests>`_.
51 If you are using a Pull Request for purposes other than review
52 (eg: precommit CI results, convenient web-based reverts, etc)
53 add the `skip-precommit-approval <https://github.com/llvm/llvm-project/labels?q=skip-precommit-approval>`_
57 ------------
64 Creating Pull Requests
65 ----------------------
66 Keep in mind that when creating a pull request, it should generally only contain one
67 self-contained commit initially.
71 recommended to create separate pull requests for each change.
74 to your `fork <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks>`_
75 of the llvm-project and
76 `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>`_.
78 as the pull request title, you may have to edit to reword or to undo this
81 Creating Pull Requests with GitHub CLI
94 When you let the GitHub CLI create a fork of llvm-project to
96 to your fork and "upstream" points to the main llvm-project repository.
98 Updating Pull Requests
99 ----------------------
100 In order to update your pull request, the only thing you need to do is to push
102 the pull request.
104 When updating a pull request, you should push additional "fix up" commits to
107 `built-in support for fixups <https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---fixupamendrewordltcommitgt>`_
111 you must use the pull request title and description as the commit message.
113 built-in tool. See the section about landing your fix below.
120 git remote -v
124 Rebasing Pull Requests and Force Pushes
125 ---------------------------------------
126 In general, you should avoid rebasing a Pull Request and force pushing to the
127 branch that's the root of the Pull Request during the review. This action will
139 changes. ``--force-with-lease`` may be useful in this situation.
142 ---------
148 -------------------
170 * `Interactive rebase <https://git-scm.com/docs/git-rebase#_interactive_mode>`_
173 your local state is correct, remember to force-push to your branch and press
181 gh pr merge --squash --delete-branch
183 If you observe an error message from the above informing you that your pull
185 modified since your pull request was authored in a way that now results in a
187 your pull request. In order to do that:
200 git rebase --continue
207 git push --force
208 gh pr merge --squash --delete-branch
211 thousands of patches (depending on how long it's been since your pull request
213 to a branch in your fork, this is ok and expected. Github's UI for the pull
218 Pre-merge Continuous Integration (CI)
219 -------------------------------------
221 Multiple checks will be applied on a pull-request, either for linting/formatting
227 better codebase and be more productive (by avoiding issues found post-merge and
235 However, please make sure you do not force-merge any changes that have clear
243 Even though your PR passed the pre-commit checks and is approved by reviewers, it
252 -------------------------------
263 `documentation <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally?platform=linux&tool=webui#modifying-an-inactive-pull-request-locally>`_
266 Example Pull Request with GitHub CLI
268 Here is an example for creating a Pull Request with the GitHub CLI:
273 gh repo clone llvm/llvm-project
276 cd llvm-project
277 git switch -c my_change
282 # Don't forget clang-format
283 git clang-format
286 ninja check-llvm
301 git commit file.cpp -m "Code Review adjustments"
304 git clang-format HEAD~
307 git commit -a --amend
311 # fork, use git remote -v to see. Usually origin points to your
312 # fork and upstream to llvm/llvm-project
315 Before merging the PR, it is recommended that you rebase locally and re-run test
321 git remote add upstream https://github.com/llvm/llvm-project.git
324 git fetch upstream && git rebase -i upstream/main
330 git push origin my_change --force
333 gh pr merge --squash --delete-branch
336 See more in-depth information about how to contribute in the following documentation:
341 Example Pull Request with git
350 First follow the instructions to [fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo?tool=webui#forking-a-repository).
352 Next follow the instructions to [clone your forked repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo?tool=webui#cloning-your-forked-repository).
359 cd llvm-project
362 git switch -c my_change
367 # Don't forget clang-format
368 git clang-format
371 ninja check-llvm
378 # fork, use git remote -v to see. Usually origin points to your
379 # fork and upstream to llvm/llvm-project
383 Create a pull request from your branch to llvm::main.
393 git commit file.cpp -m "Code Review adjustments"
396 git clang-format HEAD~
399 git commit -a --amend
401 # Re-run tests and make sure nothing broke.
406 # fork, use git remote -v to see. Usually origin points to your
407 # fork and upstream to llvm/llvm-project
410 Before merging the PR, it is recommended that you rebase locally and re-run test
416 git remote add upstream https://github.com/llvm/llvm-project.git
419 git fetch upstream && git rebase -i upstream/main
425 git push origin my_change --force
430 See more in-depth information about how to contribute in the following documentation:
439 -----------------------------------------
440 You can use special comments on issues or pull requests to make backport
442 the following command on any issue or pull request that has been added to one
447 /cherry-pick <commit> <commit> <...>
450 to cherry-pick the commit(s) to the release branch. If the commit(s) fail to
452 the issue/pull request. If the commit(s) do apply cleanly, then a pull request
456 the conflicts locally and then create a pull request against the release
457 branch. Just make sure to add the release milestone to the pull request.
464 `a Github issue <https://github.com/llvm/llvm-project/issues/new>`_ and using the ``infrastructure`` label.
466 case-by-case basis by the LLVM admins and the role can be revoked at any point as the LLVM admins see fit.