Skip to content

Clarify that bbastov is the style of Hound CI.

gitlab-qa-bot requested to merge github/fork/booktree/clarify-hound-ci-style into master

Created by: cirosantilli

Follows discussion at: https://github.com/gitlabhq/gitlabhq/pull/6752

Since https://github.com/thoughtbot/guides/tree/master/style and bbastov's style is the same, we should link only to one of them to make things clearer.

Source Code Layout corresponds to the thoughtbot formatting section.

Also make it clear that Hound CI uses bbastov's style, which is not clear from their documentation.

Questions

  1. Which "multi-line method chaining style" style are we using? Option A I imagine: dot on next line. If so I'll add that too.
  2. I think Hound is an interesting option, but what policy shall we adopt for new merge requests, when existing untouched neighboring lines are in a style not accepted by Hound, specially very symmetric ones?

For example, consider that the following code exists:

func "a" 
func "b"

and that I am going modify line 2 to:

func 'c'

and use single quotes which is the correct style. But then it will look like:

func "a" 
func 'c'

which is ugly because it is not symmetric.

Shall I also modify the first line to:

func 'a' 
func 'c'

?

This is specially problematic when you are moving chunks of code around in tests, and Hound will bark a lot, so its easier to just update the entire file rather than going back and forth from your editor to your browser.

One solution to this question is that we start an effort to update all the style to the correct one. Perhaps there are tools which help with that?

Merge request reports