summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorKaren <karen@gitlab.com>2015-05-26 00:23:25 +0000
committerKaren <karen@gitlab.com>2015-05-26 00:23:25 +0000
commit5314d6ff88ac3cd6ebf49a0a94950d8697275762 (patch)
tree353e076add7f1ec0d65da42dddf94eba837ec03d /CONTRIBUTING.md
parent4034af81314d650c78e0bb6b40c99b6eb20c4eb2 (diff)
downloadgitlab-ce-5314d6ff88ac3cd6ebf49a0a94950d8697275762.tar.gz
added link to documentation style guide
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 6b4a6102aff..c704f5ec61f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -163,6 +163,7 @@ If you add a dependency in GitLab (such as an operating system package) please c
1. [Shell commands](doc/development/shell_commands.md) created by GitLab contributors to enhance security
1. [Markdown](http://www.cirosantilli.com/markdown-styleguide)
1. [Database Migrations](doc/development/migration_style_guide.md)
+1. [Documentation styleguide](gitlab-ce/doc_styleguide.md)
1. Interface text should be written subjectively instead of objectively. It should be the gitlab core team addressing a person. It should be written in present time and never use past tense (has been/was). For example instead of "prohibited this user from being saved due to the following errors:" the text should be "sorry, we could not create your account because:". Also these [excellent writing guidelines](https://github.com/NARKOZ/guides#writing).
This is also the style used by linting tools such as [RuboCop](https://github.com/bbatsov/rubocop), [PullReview](https://www.pullreview.com/) and [Hound CI](https://houndci.com).