generic-library/libzmq
1
0
Fork 0
mirror of https://github.com/zeromq/libzmq.git synced 2024-12-13 10:52:56 +01:00
Code Issues Projects Releases Wiki Activity

Problem: PR template does not mention clang-format

Browse Source 
Solution: add paragraph explaining how to run it to make sure code is
correctly formatted.
This commit is contained in:
Luca Boccassi 2018-03-05 22:45:00 +00:00
parent 541ca30d8e
commit c36d8cb8e4
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -9,6 +9,14 @@ Problem: X is broken
Solution: do Y and Z to fix X 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 Please avoid sending a pull request with recursive merge nodes, as they
are impossible to fix once merged. Please rebase your branch on are impossible to fix once merged. Please rebase your branch on
zeromq/libzmq master instead of merging it. zeromq/libzmq master instead of merging it.