Skip to content
Ruslan Baratov edited this page Dec 11, 2015 · 10 revisions

Read wiki before making changes. Please send a patch as a pull request against the branch develop. After successfull build this branch will be merged to master. Try to follow this style guide.

Before making pull request:

  • Minimum version of CMake for using Hunter is 3.0. Please check that you're using no commands from newer versions (see documentation for 3.0)
  • Check that there is no tabs or trailing whitespaces
  • Check there is a new line at end of file
  • Set your copyrights
  • Keep your summary short so git log --pretty=oneline will look good (linux recommendation)

Keep your commits as trivial as possible, do not mix nonrelated changes in one commit. For example:

  • Do not mix renaming of variable with changes in logic - make two commits:
  1. rename variable
  2. apply other changes
  • Do not rename file and do change of it's internals - make two commits:
  1. rename file
  2. change internals
  • Quite the same with big blocks of code. If block moves with a small change make two commits:
  1. move big block only
  2. change code in block

In short keep in mind that cosmetic/trivial changes is quite easy to review (unlike logic) but they can add additional mess.

Please note that when you're updating pull request (by doing git push origin <branch-linked-to-pr>) I'm not receiving any notifications! So when you're done just add "ping" note, like @ruslo Updated!.

Vim hints

Highlight tabs and trailing whitespaces:

highlight TabsAndTrailingSpaces ctermbg=red guibg=red
match TabsAndTrailingSpaces /\t\| \+$/

80 chars margin:

let &colorcolumn=join(range(81,9999),",")

See also

Clone this wiki locally