Skip to content

[DX] Improve CONTRIBUTE.md instructions #721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
etagwerker merged 2 commits into from
Jul 7, 2025
+13 −3
Merged

[DX] Improve CONTRIBUTE.md instructions #721

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
41647da
[DX] Improve CONTRIBUTE.md instructions
arielj Jul 7, 2025
9f58623
Update History.rdoc
arielj Jul 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTE.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ upstream:

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

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

## 3. Prepare your contribution

Expand Down
7 changes: 7 additions & 0 deletions docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
services:
redis:
image: redis:6.2-alpine
restart: always
ports:
- '127.0.0.1:6379:6379'
command: redis-server --save 20 1 --loglevel warning