Commit e27d351b authored by Rémy Coutable's avatar Rémy Coutable

Merge branch 'cablett-shared-context-docs' into 'master'

Allow shared examples to be inline

See merge request gitlab-org/gitlab!23544
parents 01d0d503 03b5ac9c
...@@ -532,20 +532,24 @@ This is especially useful whenever it's showing 500 internal server error. ...@@ -532,20 +532,24 @@ This is especially useful whenever it's showing 500 internal server error.
### Shared contexts ### Shared contexts
All shared contexts should be placed under `spec/support/shared_contexts/`. Shared contexts only used in one spec file can be declared inline.
Shared contexts can be placed in subfolder if they apply to a certain type of Any shared contexts used by more than one spec file:
specs only (e.g. features, requests etc.) but shouldn't be if they apply to
multiple type of specs. - Should be placed under `spec/support/shared_contexts/`.
- Can be placed in subfolder if they apply to a certain type of specs only
(e.g. features, requests etc.) but shouldn't be if they apply to multiple type of specs.
Each file should include only one context and have a descriptive name, e.g. Each file should include only one context and have a descriptive name, e.g.
`spec/support/shared_contexts/controllers/githubish_import_controller_shared_context.rb`. `spec/support/shared_contexts/controllers/githubish_import_controller_shared_context.rb`.
### Shared examples ### Shared examples
All shared examples should be placed under `spec/support/shared_examples/`. Shared examples only used in one spec file can be declared inline.
Shared examples can be placed in subfolder if they apply to a certain type of Any shared examples used by more than one spec file:
specs only (e.g. features, requests etc.) but shouldn't be if they apply to
multiple type of specs. - Should be placed under `spec/support/shared_examples/`.
- Can be placed in subfolder if they apply to a certain type of specs only
(e.g. features, requests etc.) but shouldn't be if they apply to multiple type of specs.
Each file should include only one context and have a descriptive name, e.g. Each file should include only one context and have a descriptive name, e.g.
`spec/support/shared_examples/controllers/githubish_import_controller_shared_example.rb`. `spec/support/shared_examples/controllers/githubish_import_controller_shared_example.rb`.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment