diff options
| author | Sytse Sijbrandij <sytse@gitlab.com> | 2015-01-13 18:27:35 +0000 |
|---|---|---|
| committer | Sytse Sijbrandij <sytse@gitlab.com> | 2015-01-13 18:27:35 +0000 |
| commit | e351b26f84824d024d552ac9cf6a27a75c9c29d8 (patch) | |
| tree | 7662cbef0963e47c803533fb63bc927bfdb1e506 | |
| parent | 9ce7492e58d3a90cfd9a07be6ba5b0f4fafe7bc8 (diff) | |
| parent | f26c0fa556be1903c1a6aebf104a82363ced96cf (diff) | |
| download | gitlab-ce-e351b26f84824d024d552ac9cf6a27a75c9c29d8.tar.gz | |
Merge branch 'prose-requirement' into 'master'
Prose requirement
Feel free to improve or link to authoritative source.
See merge request !285
| -rw-r--r-- | CONTRIBUTING.md | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c82a4c623e0..d26cf567e36 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:". 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). |