[all-commits] [llvm/llvm-project] 3dda10: [docs] Advise contributors to check for truncated ...

[Alex Bradbury via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 3dda1040d3fe56dbd8afd2eb823e891954de13f3
      https://github.com/llvm/llvm-project/commit/3dda1040d3fe56dbd8afd2eb823e891954de13f3
  Author: Alex Bradbury <asb at igalia.com>
  Date:   2023-10-02 (Mon, 02 Oct 2023)

  Changed paths:
    M llvm/docs/GitHub.rst

  Log Message:
  -----------
  [docs] Advise contributors to check for truncated PR titles (#68021)

GitHub will use the first line of the commit as the title for a
single-commit PR, but truncates it at 72 characters
<https://github.com/orgs/community/discussions/12450>. This truncation
makes the PRs less readable if not manually undone, and even worse, the
truncated form may survive through to commit if "Squash and rebase" is
used in the GitHub web UI. From preparing LLVM Weekly, I've seen this a
number of times and it really does make it more annoying to flick
through commits.

I'm not sure if this is the best place for the guidance, or whether you
get the same behaviour when creating a PR with `gh`, but I'm quite keen
we give a warning of some sort about this behaviour.