Port some RuboCop and doc changes from EE
Signed-off-by: Rémy Coutable <remy@rymai.me>
This commit is contained in:
parent
7f4b14b104
commit
2bdb578032
3 changed files with 33 additions and 6 deletions
28
.rubocop.yml
28
.rubocop.yml
|
@ -10,15 +10,26 @@ AllCops:
|
||||||
Exclude:
|
Exclude:
|
||||||
- 'vendor/**/*'
|
- 'vendor/**/*'
|
||||||
- 'node_modules/**/*'
|
- 'node_modules/**/*'
|
||||||
- 'db/*'
|
- 'db/**/*'
|
||||||
- 'db/fixtures/**/*'
|
- 'db/fixtures/**/*'
|
||||||
- 'db/geo/*'
|
- 'ee/db/**/*'
|
||||||
- 'tmp/**/*'
|
- 'tmp/**/*'
|
||||||
- 'bin/**/*'
|
- 'bin/**/*'
|
||||||
- 'generator_templates/**/*'
|
- 'generator_templates/**/*'
|
||||||
- 'builds/**/*'
|
- 'builds/**/*'
|
||||||
CacheRootDirectory: tmp
|
CacheRootDirectory: tmp
|
||||||
|
|
||||||
|
# This cop checks whether some constant value isn't a
|
||||||
|
# mutable literal (e.g. array or hash).
|
||||||
|
Style/MutableConstant:
|
||||||
|
Enabled: true
|
||||||
|
Exclude:
|
||||||
|
- 'db/migrate/**/*'
|
||||||
|
- 'db/post_migrate/**/*'
|
||||||
|
- 'ee/db/migrate/**/*'
|
||||||
|
- 'ee/db/post_migrate/**/*'
|
||||||
|
- 'ee/db/geo/migrate/**/*'
|
||||||
|
|
||||||
# Gitlab ###################################################################
|
# Gitlab ###################################################################
|
||||||
|
|
||||||
Gitlab/ModuleWithInstanceVariables:
|
Gitlab/ModuleWithInstanceVariables:
|
||||||
|
@ -33,3 +44,16 @@ Gitlab/ModuleWithInstanceVariables:
|
||||||
# We ignore spec helpers because it usually doesn't matter
|
# We ignore spec helpers because it usually doesn't matter
|
||||||
- spec/support/**/*.rb
|
- spec/support/**/*.rb
|
||||||
- features/steps/**/*.rb
|
- features/steps/**/*.rb
|
||||||
|
|
||||||
|
GitlabSecurity/PublicSend:
|
||||||
|
Enabled: true
|
||||||
|
Exclude:
|
||||||
|
- 'config/**/*'
|
||||||
|
- 'db/**/*'
|
||||||
|
- 'features/**/*'
|
||||||
|
- 'lib/**/*.rake'
|
||||||
|
- 'qa/**/*'
|
||||||
|
- 'spec/**/*'
|
||||||
|
- 'ee/db/**/*'
|
||||||
|
- 'ee/lib/**/*.rake'
|
||||||
|
- 'ee/spec/**/*'
|
||||||
|
|
|
@ -28,9 +28,8 @@ we still need to merge changes from GitLab CE to EE. To help us get there,
|
||||||
we should make sure that we no longer edit CE files in place in order to
|
we should make sure that we no longer edit CE files in place in order to
|
||||||
implement EE features.
|
implement EE features.
|
||||||
|
|
||||||
Instead, all EE codes should be put inside the `ee/` top-level directory, and
|
Instead, all EE code should be put inside the `ee/` top-level directory. The
|
||||||
tests should be put inside `spec/ee/`. We don't use `ee/spec` for now due to
|
rest of the code should be as close to the CE files as possible.
|
||||||
technical limitation. The rest of codes should be as close as to the CE files.
|
|
||||||
|
|
||||||
[single code base]: https://gitlab.com/gitlab-org/gitlab-ee/issues/2952#note_41016454
|
[single code base]: https://gitlab.com/gitlab-org/gitlab-ee/issues/2952#note_41016454
|
||||||
|
|
||||||
|
@ -318,7 +317,7 @@ When you're testing EE-only features, avoid adding examples to the
|
||||||
existing CE specs. Also do no change existing CE examples, since they
|
existing CE specs. Also do no change existing CE examples, since they
|
||||||
should remain working as-is when EE is running without a license.
|
should remain working as-is when EE is running without a license.
|
||||||
|
|
||||||
Instead place EE specs in the `spec/ee/spec` folder.
|
Instead place EE specs in the `ee/spec` folder.
|
||||||
|
|
||||||
## JavaScript code in `assets/javascripts/`
|
## JavaScript code in `assets/javascripts/`
|
||||||
|
|
||||||
|
|
|
@ -134,6 +134,10 @@ learn more.
|
||||||
[GitLab QA]: https://gitlab.com/gitlab-org/gitlab-qa
|
[GitLab QA]: https://gitlab.com/gitlab-org/gitlab-qa
|
||||||
[part of GitLab Rails]: https://gitlab.com/gitlab-org/gitlab-ce/tree/master/qa
|
[part of GitLab Rails]: https://gitlab.com/gitlab-org/gitlab-ce/tree/master/qa
|
||||||
|
|
||||||
|
## EE-specific tests
|
||||||
|
|
||||||
|
EE-specific tests follows the same organization, but under the `ee/spec` folder.
|
||||||
|
|
||||||
## How to test at the correct level?
|
## How to test at the correct level?
|
||||||
|
|
||||||
As many things in life, deciding what to test at each level of testing is a
|
As many things in life, deciding what to test at each level of testing is a
|
||||||
|
|
Loading…
Reference in a new issue