Skip to content

Commit 5385d2b

Browse files
cbliardsebjacobs
authored andcommitted
Improve doc about Job specs & Rails versions matrix (rspec#1886)
* Improve doc about Job specs & rails versions matrix * Add System specs information in doc * doc: add links from directory structure feature to other features * doc: simpler links to other features
1 parent 477dad2 commit 5385d2b

File tree

2 files changed

+16
-9
lines changed

2 files changed

+16
-9
lines changed

features/RailsVersions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,5 @@
66
4.0 | >= 2.14
77
4.1 | >= 3.0
88
4.2 | >= 3.1
9+
5.0 | >= 3.5
10+
5.1 | >= 3.6

features/directory_structure.feature

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,18 @@ Feature: Directory Structure
33
Specs are usually placed in a canonical directory structure that describes
44
their purpose:
55

6-
- Model specs reside in the `spec/models` directory
7-
- Controller specs reside in the `spec/controllers` directory
8-
- Request specs reside in the `spec/requests` directory. The directory
9-
can also be named `integration` or `api`.
10-
- Feature specs reside in the `spec/features` directory
11-
- View specs reside in the `spec/views` directory
12-
- Helper specs reside in the `spec/helpers` directory
13-
- Mailer specs reside in the `spec/mailers` directory
14-
- Routing specs reside in the `spec/routing` directory
6+
- [Model specs](model-specs) reside in the `spec/models` directory
7+
- [Controller specs](controller-specs) reside in the `spec/controllers`
8+
directory
9+
- [Request specs](request-specs) reside in the `spec/requests` directory. The
10+
directory can also be named `integration` or `api`.
11+
- [Feature specs](feature-specs) reside in the `spec/features` directory
12+
- [View specs](view-specs) reside in the `spec/views` directory
13+
- [Helper specs](helper-specs) reside in the `spec/helpers` directory
14+
- [Mailer specs](mailer-specs) reside in the `spec/mailers` directory
15+
- [Routing specs](routing-specs) reside in the `spec/routing` directory
16+
- [Job specs](job-specs) reside in the `spec/jobs` directory
17+
- [System specs](system-specs) reside in the `spec/system` directory
1518

1619
Application developers are free to use a different directory structure. In
1720
order to include the correct `rspec-rails` support functions, the specs need
@@ -25,6 +28,8 @@ Feature: Directory Structure
2528
- Helper specs: `type: :helper`
2629
- Mailer specs: `type: :mailer`
2730
- Routing specs: `type: :routing`
31+
- Job specs: `type: :job`
32+
- System specs: `type: :system`
2833

2934
For example, say the spec for the `ThingsController` is located in
3035
`spec/legacy/things_controller_spec.rb`. Simply tag the spec's

0 commit comments

Comments
 (0)