summaryrefslogtreecommitdiff
path: root/doc/development/code_comments.md
blob: 827a610efa25b39cdd2ee68ec94d27947fafabba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# Code comments

Whenever you add comment to the code that is expected to be addressed at any time
in future, please create a technical debt issue for it. Then put a link to it
to the code comment you've created. This will allow other developers to quickly
check if a comment is still relevant and what needs to be done to address it.

Examples:

```rb
# Deprecated scope until code_owner column has been migrated to rule_type.
# To be removed with https://gitlab.com/gitlab-org/gitlab-ee/issues/11834.
scope :code_owner, -> { where(code_owner: true).or(where(rule_type: :code_owner)) }
```