Skip to content

Commit c2877ea

Browse files
authored
docs: Completes the developer/contributing docs (#19)
1 parent 60acf89 commit c2877ea

File tree

3 files changed

+13
-6
lines changed

3 files changed

+13
-6
lines changed

Gemfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ gem 'minitest-global_expectations'
1010
gem 'pg'
1111
gem 'pry'
1212
gem 'rake', '~> 13.0'
13+
gem 'reline'
1314
gem 'rubocop', '~> 1.21'
1415
gem 'rubocop-minitest'
1516
gem 'rubocop-rake'

Readme.adoc

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -139,14 +139,20 @@ spgt_test=#
139139
140140
## Development
141141
142-
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
142+
After checking out the repo, run `bundle install` or `bin/setup` to install dependencies.
143143
144-
To install this gem onto your local machine, run `bundle exec rake install`.
144+
Then, either set the PGT_SPEC_DB environment variable to an existing PostgreSQL db of your choice,
145+
or run `rake createdb` to create a testing one (`spgt_test`).
146+
147+
Finally run `rake spec` to run the tests.
148+
149+
You can also run `bin/console` for an interactive prompt that will allow you to experiment.
150+
151+
To install this gem from source onto your local machine, run `bundle exec rake install`.
145152
146153
### Conventional Commits & Commit Messages
147154
148-
This project uses the {conventional-commits}
149-
specification for commit messages, as well as for PR titles.
155+
This project uses the {conventional-commits} specification for commit messages, as well as for PR titles.
150156
This allows for automated (by {release-please}) release management, changelog generation, and versioning.
151157
Please follow the specification when writing commit messages.
152158

bin/console

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ require 'sequel/pgt_outbox'
77
# You can add fixtures and/or initialization code here to make experimenting
88
# with your gem easier. You can also use a different console, if you like.
99

10-
require 'irb'
11-
IRB.start(__FILE__)
10+
require 'pry'
11+
Rubyists::PgtOutbox.pry

0 commit comments

Comments
 (0)