diff --git a/docs/01-readme.md b/docs/01-readme.md index acfd34cf..52674389 100644 --- a/docs/01-readme.md +++ b/docs/01-readme.md @@ -51,7 +51,8 @@ problem. Please report any issues you may find on [our bugtracker](https://github.com/awesomeWM/awesome/issues). You can submit pull requests on the [github repository](https://github.com/awesomeWM/awesome). -Please read the @{02-contributing.md} guide for any coding, documentation or patch guidelines. +Please read the [contributing guide](https://github.com/awesomeWM/awesome/blob/master/docs/02-contributing.md) +for any coding, documentation or patch guidelines. ## Status [![Build Status](https://travis-ci.org/awesomeWM/awesome.svg?branch=master)](https://travis-ci.org/awesomeWM/awesome) diff --git a/docs/02-contributing.md b/docs/02-contributing.md index 2013ae69..8d887e10 100644 --- a/docs/02-contributing.md +++ b/docs/02-contributing.md @@ -16,14 +16,14 @@ Imitate the existing code style. For concrete rules: - Place braces alone on new lines, and do not place braces for single line statement where it is not needed, i.e.: - if(foo) - x = 1; + if(foo) + x = 1; - if(foo) - { - x = 1; - bar(); - } + if(foo) + { + x = 1; + bar(); + } - Do not put a space after if, for, while or function call statements;