Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Boxiang Sun
gitlab-ce
Commits
75fd8a40
Commit
75fd8a40
authored
Jun 25, 2019
by
Dmitriy Zaporozhets
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add code comments development guide
Signed-off-by:
Dmitriy Zaporozhets
<
dmitriy.zaporozhets@gmail.com
>
parent
f904971e
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
15 additions
and
0 deletions
+15
-0
doc/development/README.md
doc/development/README.md
+1
-0
doc/development/code_comments.md
doc/development/code_comments.md
+14
-0
No files found.
doc/development/README.md
View file @
75fd8a40
...
...
@@ -108,6 +108,7 @@ description: 'Learn how to contribute to GitLab.'
-
[
Database Debugging and Troubleshooting
](
database_debugging.md
)
-
[
Query Count Limits
](
query_count_limits.md
)
-
[
Database helper modules
](
database_helpers.md
)
-
[
Code comments
](
code_comments.md
)
## Integration guides
...
...
doc/development/code_comments.md
0 → 100644
View file @
75fd8a40
# 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
))
}
```
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment