Skip to content

[llvm][docs] Reorder sections in GitHub.rst #134212

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 3 commits into from
Apr 7, 2025

Conversation

banach-space
Copy link
Contributor

@banach-space banach-space commented Apr 3, 2025

Reorder sections in GitHub.rst so that "Branches" and "Stacked Pull
Requests" appear after the more general section on pull requests. This
improves the conceptual flow for readers new to the process:

New order:

  • Introduction
  • Before your first PR
  • Pull Requests
  • Approvals
  • Landing your change
  • Branches
  • Stacked Pull Requests
  • ...

Previous order:

  • Introduction
  • Before your first PR
  • Branches
  • Stacked Pull Requests
  • Pull Requests
  • Approvals
  • Landing your change
  • ...

This change only reorders existing text - no content edits.

Copy link
Member

@paschalis-mpeis paschalis-mpeis left a comment

Choose a reason for hiding this comment

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

I like the new order better because it moves an advanced topic later on in the guide, but also lays out "Stacked Pull Requests" after "Pull Requests".


I also can't help but think of this minor tweak too:

  • Branches
  • Pull Requests
  • Stacked Pull Requests

On one hand the above order feels slightly more natural to me.
But on the other hand the Branches section is very brief ATM, and is mostly tied to stacked PRs.

@mstorsjo
Copy link
Member

mstorsjo commented Apr 3, 2025

I like the new order better because it moves an advanced topic later on in the guide, but also lays out "Stacked Pull Requests" after "Pull Requests".

I also can't help but think of this minor tweak too:

  • Branches
  • Pull Requests
  • Stacked Pull Requests

On one hand the above order feels slightly more natural to me. But on the other hand the Branches section is very brief ATM, and is mostly tied to stacked PRs.

I'd prefer this order here, keeping Branches later, as they're not essential for the basic workflow, they're only needed for stacked PRs.

I'm somewhat wondering if it'd be better to move the bit on branches and stacked PRs even further down, so that the basic workflow with these bits are sequentially at first, then diving into the bits of advanced PRs only later.

  • Before your first PR
  • Pull Requests
  • Approvals
  • Landing your change

But the suggested order is clearly better than what we have right now anyway.

@banach-space
Copy link
Contributor Author

I'm somewhat wondering if it'd be better to move the bit on branches and stacked PRs even further down, so that the basic workflow with these bits are sequentially at first, then diving into the bits of advanced PRs only later.

+1 Updated :)

@DavidSpickett
Copy link
Collaborator

Yeah in some logical "walls of text don't scare me" way, branches and stacked pull requests are a decision you would make before you start, but 99% of the audience won't need it to begin with.

And it's not like uploading a branch from your fork to llvm/llvm-project, or converting a PR with many commits into a stacked PR is that hard to do.

I like the new order. Also a table of contents will mitigate order being a problem, surprised we didn't have one already.

Copy link
Member

@mstorsjo mstorsjo left a comment

Choose a reason for hiding this comment

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

This order LGTM!

@paschalis-mpeis
Copy link
Member

I'd prefer this order here, keeping Branches later, as they're not essential for the basic workflow, they're only needed for stacked PRs.

Just clarifying that I too agree with this order: simple to advanced topics. 👌

Reorder sections in GitHub.rst so that "Branches" and "Stacked Pull
Requests" appear after the more general section on pull requests. This
improves the conceptual flow for readers new to the process:

New order:
  * Introduction
  * Before your first PR
  * Pull Requests
  * Branches
  * Stacked Pull Requests
  * Approvals
  * Landing your change
  * ...

Previous order:
  * Introduction
  * Before your first PR
  * Branches
  * Stacked Pull Requests
  * Pull Requests
  * Approvals
  * Landing your change
  * ...

This change only reorders existing text - no content edits.
Shuffle according to feedback from Martin, add ToC
@banach-space banach-space force-pushed the andrzej/docs/github_order branch from 78245a4 to 55f1fe6 Compare April 7, 2025 10:19
@banach-space banach-space merged commit c9157d4 into llvm:main Apr 7, 2025
10 checks passed
@banach-space banach-space deleted the andrzej/docs/github_order branch April 7, 2025 10:37
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.

4 participants