From 298357e25d28644f4b95a61d74087aafb6fdd180 Mon Sep 17 00:00:00 2001 From: "Elijah C. Voigt" Date: Mon, 24 Oct 2016 17:46:23 -0700 Subject: [PATCH] docs: mention CoreOS docs style guide That style guide is (or ought to be) enforced in all CoreOS repository documentation (.md files). This change makes that more obvious. --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9d028a76..2fd5f92b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,6 +41,8 @@ This is a rough outline of what a contributor's workflow looks like: Thanks for your contributions! +**Note**: When editing documentation you should follow the [CoreOS Docs Style Guide][coreos-docs-style]. + ## Proposals For very simple contributions - bug fixes, documentation tweaks, small optimizations, etc. - a proposal is not neccesary. Otherwise, it's necessary to discuss your proposal with other members of the community and get approval from the maintainers. @@ -82,3 +84,5 @@ The first line is the subject and should be no longer than 70 characters, the second line is always blank, and other lines should be wrapped at 80 characters. This allows the message to be easier to read on GitHub as well as in various git tools. + +[coreos-docs-style]: https://github.com/coreos/docs/blob/master/STYLE.md