Skip to content

Commit f50ccb2

Browse files
authored
[DX] Improve CONTRIBUTE.md instructions (#721)
* [DX] Improve CONTRIBUTE.md instructions * Update History.rdoc
1 parent f4780bc commit f50ccb2

File tree

3 files changed

+13
-3
lines changed

3 files changed

+13
-3
lines changed

CONTRIBUTE.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ upstream:
1212

1313
- `bundle install`
1414
- Copy `spec/support/sample.config.yml` to `spec/support/config.yml` and edit it
15-
- Run the tests with `bundle exec rspec`
15+
- Run the tests with `bundle exec rspec` and `bundle exec cucumber`
1616

17-
Note that if you don't have all the supported databases installed and running,
18-
some tests will fail.
17+
Note that the Cucumber specs require `redis` to be running, you can either run it globally
18+
on your system or use the provided `docker-compose.yml` file and run `docker compose up`.
1919

2020
## 3. Prepare your contribution
2121

History.rdoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
== Development (unreleased)
22

3+
== Chores
4+
* Update CONTRIBUTE.md to mention Cucumber specs and Redis dependency https://github.com/DatabaseCleaner/database_cleaner/pull/721
5+
36
== 2.1.0 2024-10-24
47

58
=== Changes

docker-compose.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
services:
2+
redis:
3+
image: redis:6.2-alpine
4+
restart: always
5+
ports:
6+
- '127.0.0.1:6379:6379'
7+
command: redis-server --save 20 1 --loglevel warning

0 commit comments

Comments
 (0)