diff options
author | Sytse Sijbrandij <sytse@gitlab.com> | 2015-01-13 10:26:55 -0800 |
---|---|---|
committer | Sytse Sijbrandij <sytse@gitlab.com> | 2015-01-13 10:26:55 -0800 |
commit | f26c0fa556be1903c1a6aebf104a82363ced96cf (patch) | |
tree | 2f53aba6d1c8843e7e97acb49dfdb6be49bb296d /CONTRIBUTING.md | |
parent | a28cad0cf3cdb387e6da221ba2feef73182013da (diff) | |
download | gitlab-ce-f26c0fa556be1903c1a6aebf104a82363ced96cf.tar.gz |
Link to guidelines for interface text.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c49a3b2e787..d26cf567e36 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -151,7 +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:". +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). |