Skip to content

Commit

Permalink
Merge pull request opencontainers#369 from wking/sentence-line-style
Browse files Browse the repository at this point in the history
style: Move one-sentence-per-line rule over from the README
  • Loading branch information
Mrunal Patel committed Apr 6, 2016
2 parents 81b865d + e0525bc commit 91c67c7
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 0 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,12 +82,6 @@ You can subscribe and join the mailing list on [Google Groups](https://groups.go

OCI discussion happens on #opencontainers on Freenode ([logs][irc-logs]).

## Markdown style

To keep consistency throughout the Markdown files in the Open Container spec all files should be formatted one sentence per line.
This fixes two things: it makes diffing easier with git and it resolves fights about line wrapping length.
For example, this paragraph will span three lines in the Markdown source.

## Git commit

### Sign your work
Expand Down
6 changes: 6 additions & 0 deletions style.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Style and conventions

## One sentence per line

To keep consistency throughout the Markdown files in the Open Container spec all files should be formatted one sentence per line.
This fixes two things: it makes diffing easier with git and it resolves fights about line wrapping length.
For example, this paragraph will span three lines in the Markdown source.

## Traditionally hex settings should use JSON integers, not JSON strings

For example, [`"classID": 1048577`][class-id] instead of `"classID": "0x100001"`.
Expand Down

0 comments on commit 91c67c7

Please sign in to comment.