summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorSytse Sijbrandij <sytse@gitlab.com>2015-01-07 14:59:22 -0800
committerSytse Sijbrandij <sytse@gitlab.com>2015-01-07 14:59:22 -0800
commit703087b8bfb2e416cc429da28a4bf7b12743ff49 (patch)
tree18825b42dc4d59cf2559159b6f9694dd8665ff42 /CONTRIBUTING.md
parent757df0142f521380b92d28a721a7fd2bd8aa382f (diff)
downloadgitlab-ce-703087b8bfb2e416cc429da28a4bf7b12743ff49.tar.gz
User interface text guideline added.prose-requirement
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 c82a4c623e0..c49a3b2e787 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -151,6 +151,7 @@ If you add a dependency in GitLab (such as an operating system package) please c
1. [CoffeeScript](https://github.com/thoughtbot/guides/tree/master/style#coffeescript)
1. [Shell commands](doc/development/shell_commands.md) created by GitLab contributors to enhance security
1. [Markdown](http://www.cirosantilli.com/markdown-styleguide)
+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:".
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).