Skip to content

Commit

Permalink
CONTRIBUTING.md: formatting guidelines
Browse files Browse the repository at this point in the history
- Enable C syntax highlightin in the example
- Update tabs recommendation (keep existing styles, move to tab stop of
  4 spaces)

Thanks to @fniephaus and @nicolas-cellier-aka-nice for their feedback.
  • Loading branch information
akgrant committed Jan 28, 2019
1 parent 4928759 commit 2267229
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ same formatting conventions as exist in the file.
C function declarations should have the type on one line and the
function name and parameters on the following line, e.g.:

```
```c
static int
convertCopy(char *from, int fromLen, char *to, int toLen, int term)
```
Expand All @@ -235,7 +235,10 @@ This facilitates searching for function definitions by searching for the
name at the beginning of the line.
## Tabs are 4 spaces
## Tab stops are 4 spaces
In this case the first rule is to keep the existing formatting within a
file - we don't want to polute the code history with space changes.
The heading says it all.
The goal is to use tabs set to 4 spaces.

0 comments on commit 2267229

Please sign in to comment.