summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2016-01-12 16:16:29 +0100
committerAchilleas Pipinellis <axilleas@axilleas.me>2016-01-12 16:19:11 +0100
commit20c327fcfde414bbc3011ba076538bfb3d557e94 (patch)
tree0367f70de7b3983bd5c2a26d2615ec2a48260376
parent5a757a63899fba66e08bf65870a288d7be207b09 (diff)
downloadgitlab-ce-doc_styleguide.tar.gz
Clarify the naming guidelinedoc_styleguide
[ci skip]
-rw-r--r--doc/development/doc_styleguide.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md
index df2507a34d0..17c6b9d4c92 100644
--- a/doc/development/doc_styleguide.md
+++ b/doc/development/doc_styleguide.md
@@ -5,7 +5,10 @@ it organized and easy to find.
## Naming
-- Use underscores for all names, including new documentation and images
+- When creating a new document and it has more than one word in its name,
+ make sure to use underscores instead of spaces or dashes (`-`). For example,
+ a proper naming would be `import_projects_from_github.md`. The same rule
+ applies to images.
## Text