From c36d8cb8e42ce8e95d46384bb48184d717b588a0 Mon Sep 17 00:00:00 2001 From: Luca Boccassi Date: Mon, 5 Mar 2018 22:45:00 +0000 Subject: [PATCH] Problem: PR template does not mention clang-format Solution: add paragraph explaining how to run it to make sure code is correctly formatted. --- .github/PULL_REQUEST_TEMPLATE.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d0cb6195..a58221c5 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -9,6 +9,14 @@ Problem: X is broken Solution: do Y and Z to fix X ``` +Please try to have the code changes conform to our coding style. For your +convenience, you can install clang-format (at least version 5.0) and then +run ```make clang-format-check```. Don't fix existing issues, if any - just +make sure your changes are compliant. ```make clang-format-diff``` will +automatically apply the required changes. +To set a specific clang-format binary with autotools, you can for example +run: ```./configure CLANG_FORMAT=clang-format-5.0``` + Please avoid sending a pull request with recursive merge nodes, as they are impossible to fix once merged. Please rebase your branch on zeromq/libzmq master instead of merging it.