Uploaded image for project: 'Swift'
  1. Swift
  2. SR-13254

[docs] Add documentation on how to format changes for a PR using `clang-format`

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Closed
    • Priority: Medium
    • Resolution: Done
    • Component/s: Compiler
    • Labels:
      None

      Description

      We should write step-by-step instructions so we can point people to it, instead of having each new contributor figure out how to invoke `clang-format-diff.py` properly.

      This how-to guide should cover:

      1. If clang-format needs to be on your PATH or not.
      2. How to apply the formatting non-destructively, check the changes, and then collapse the changes properly. Sometimes clang-format is too aggressive and touches lines which are not changed by a patch.
      3. How to format all the commits in a PR.

        Attachments

          Activity

            People

            Assignee:
            theindigamer Varun Gandhi
            Reporter:
            theindigamer Varun Gandhi
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: