diff --git a/llvm/docs/GitHub.rst b/llvm/docs/GitHub.rst --- a/llvm/docs/GitHub.rst +++ b/llvm/docs/GitHub.rst @@ -19,6 +19,32 @@ the future if needed to support "stacked" pull request, but in that case only branches being used for "stacked" pull requests will be allowed. +Pull Requests +============= +The LLVM Project does not currently accept pull requests for the llvm/llvm-project +repository. However, there is a +`plan `_ to move +to pull requests in the future. This section documents the pull request +policies LLVM will be adopting once the project starts using them. + +Creating Pull Requests +^^^^^^^^^^^^^^^^^^^^^^ +For pull requests, please push a branch to your fork of the llvm-project and +`create a pull request from the fork `_. + + +Updating Pull Requests +^^^^^^^^^^^^^^^^^^^^^^ +When updating a pull request, you may push additional "fix up" commits to +your branch instead of force pushing. This makes it easier for github to +track the context of previous review comments. + +If you choose to do this, you must squash and merge before committing and +you must use the pull request title and description as the commit message. +The default commit message for a squashed pull request is the pull reqeust +description, so this will allow reviewers to review the commit message before +approving the commit. + Releases ========