Skip to content

[llvm][docs] Clean up the "Landing Your Change" section of the GitHub docs #112869

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
merged 4 commits into from
Oct 23, 2024

Conversation

DavidSpickett
Copy link
Collaborator

@DavidSpickett DavidSpickett commented Oct 18, 2024

  • Note up front that the author may not have permissions to use the merge button and should ask a reviewer to do those steps.
  • Make it clear that a single commit PR can be landed with a single button click.
  • There are in fact 3 ways to land a multi-commit PR.
  • Order the ways in increasing amount of overhead for the PR author.
  • Put them in bullet point sections so they are visually separate.

… docs

* Note up front that the author may not have permissions to use
  the merge button and should ask a reviewer to do those steps.
* Make it clear that a single commit PR can be landed with a single
  button click.
* There are in fact 3 ways to land a multi-commit PR.
* Order the ways in increasing amount of overhead for the PR
  author.
* Put them in bullet point sections so they are visualy separate.
@DavidSpickett
Copy link
Collaborator Author

@JL2210 This may address some of your feedback on the doc. I will look at the doc as a whole in another PR.

@JL2210
Copy link
Contributor

JL2210 commented Oct 18, 2024

This looks fine to me. Much more clear than it was.

Copy link
Member

@nickdesaulniers nickdesaulniers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DavidSpickett DavidSpickett merged commit dfc4065 into llvm:main Oct 23, 2024
6 of 9 checks passed
@DavidSpickett DavidSpickett deleted the llvm-github branch October 23, 2024 08:52
@frobtech frobtech mentioned this pull request Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants