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
d603cf2f
Commit
d603cf2f
authored
Feb 16, 2017
by
Achilleas Pipinellis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Do not use single quote in headings as it breaks docs.gitlab.com
[ci skip]
parent
edecab20
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
4 additions
and
4 deletions
+4
-4
doc/development/gotchas.md
doc/development/gotchas.md
+4
-4
No files found.
doc/development/gotchas.md
View file @
d603cf2f
...
@@ -3,7 +3,7 @@
...
@@ -3,7 +3,7 @@
The purpose of this guide is to document potential "gotchas" that contributors
The purpose of this guide is to document potential "gotchas" that contributors
might encounter or should avoid during development of GitLab CE and EE.
might encounter or should avoid during development of GitLab CE and EE.
## Do
n'
t `describe` symbols
## Do
no
t `describe` symbols
Consider the following model spec:
Consider the following model spec:
...
@@ -32,7 +32,7 @@ spec/models/user_spec.rb|6 error| Failure/Error: u = described_class.new NoMeth
...
@@ -32,7 +32,7 @@ spec/models/user_spec.rb|6 error| Failure/Error: u = described_class.new NoMeth
Except for the top-level
`describe`
block, always provide a String argument to
Except for the top-level
`describe`
block, always provide a String argument to
`describe`
.
`describe`
.
## Do
n'
t assert against the absolute value of a sequence-generated attribute
## Do
no
t assert against the absolute value of a sequence-generated attribute
Consider the following factory:
Consider the following factory:
...
@@ -121,7 +121,7 @@ describe API::Labels do
...
@@ -121,7 +121,7 @@ describe API::Labels do
end
end
```
```
## Do
n'
t `rescue Exception`
## Do
no
t `rescue Exception`
See
[
"Why is it bad style to `rescue Exception => e` in Ruby?"
][
Exception
]
.
See
[
"Why is it bad style to `rescue Exception => e` in Ruby?"
][
Exception
]
.
...
@@ -130,7 +130,7 @@ Rubocop](https://gitlab.com/gitlab-org/gitlab-ce/blob/8-4-stable/.rubocop.yml#L9
...
@@ -130,7 +130,7 @@ Rubocop](https://gitlab.com/gitlab-org/gitlab-ce/blob/8-4-stable/.rubocop.yml#L9
[
Exception
]:
http://stackoverflow.com/q/10048173/223897
[
Exception
]:
http://stackoverflow.com/q/10048173/223897
## Do
n'
t use inline JavaScript in views
## Do
no
t use inline JavaScript in views
Using the inline
`:javascript`
Haml filters comes with a
Using the inline
`:javascript`
Haml filters comes with a
performance overhead. Using inline JavaScript is not a good way to structure your code and should be avoided.
performance overhead. Using inline JavaScript is not a good way to structure your code and should be avoided.
...
...
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