Skip to content

Commit a9779fe

Browse files
committed
Move TESTS section to CONTRIBUTING.md and trim contributors list
Migrate the manual database setup, dependency install, and test invocation steps from README's TESTS section into CONTRIBUTING.md (under a new "Manual setup (without devcontainer)" section) and replace the README section with a pointer. The README's hand-maintained CONTRIBUTORS list is replaced with a thank-you note plus a link to github.com/rsim/ruby-plsql/graphs/contributors so the canonical list lives on GitHub instead of drifting in the repo.
1 parent d63dbda commit a9779fe

2 files changed

Lines changed: 38 additions & 32 deletions

File tree

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,3 +108,39 @@ BUNDLE_ONLY=rubocop bundle exec rubocop --parallel
108108
```
109109

110110
These are the same commands CI runs (`.github/workflows/rubocop.yml`).
111+
112+
## Manual setup (without devcontainer)
113+
114+
If you prefer to develop against an existing Oracle Database, review
115+
`spec/spec_helper.rb` for the default schema/user names and database
116+
names (override via environment variables as needed).
117+
118+
### Prepare the database
119+
120+
Use any reachable Oracle Database and create the test schemas:
121+
122+
```sql
123+
CREATE USER hr IDENTIFIED BY hr;
124+
GRANT unlimited tablespace, create session, create table,
125+
create sequence, create procedure, create type,
126+
create view, create synonym TO hr;
127+
128+
CREATE USER arunit IDENTIFIED BY arunit;
129+
GRANT create session TO arunit;
130+
```
131+
132+
The CI helper `ci/setup_accounts.sh` performs the equivalent setup
133+
against `${DATABASE_NAME}` using `${DATABASE_SYS_PASSWORD}`.
134+
135+
### Prepare dependencies
136+
137+
```sh
138+
gem install bundler
139+
bundle install
140+
```
141+
142+
### Run the suite
143+
144+
```sh
145+
bundle exec rake spec
146+
```

README.md

Lines changed: 2 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -180,31 +180,7 @@ Make sure you use correct version of Oracle client for database you're connectin
180180
TESTS
181181
-----
182182

183-
Review `spec/spec_helper.rb` to see default schema/user names and database names (use environment variables to override defaults)
184-
185-
##### Prepare database
186-
187-
In an Oracle Database create the following schemas for test purposes.
188-
189-
SQL> CREATE USER hr IDENTIFIED BY hr;
190-
SQL> GRANT unlimited tablespace, create session, create table, create sequence, create procedure, create type, create view, create synonym TO hr;
191-
192-
SQL> CREATE USER arunit IDENTIFIED BY arunit;
193-
SQL> GRANT create session TO arunit;
194-
195-
##### Prepare dependencies
196-
197-
* Install bundler with
198-
199-
gem install bundler
200-
201-
* Install necessary gems with
202-
203-
bundle install
204-
205-
##### Run tests
206-
207-
rake spec
183+
See [CONTRIBUTING.md](CONTRIBUTING.md) for how to set up a development environment and run the spec suite.
208184

209185
LINKS
210186
-----
@@ -216,13 +192,7 @@ LINKS
216192
CONTRIBUTORS
217193
------------
218194

219-
* Raimonds Simanovskis
220-
* Edgars Beigarts
221-
* Oleh Mykytyuk
222-
* Wiehann Matthysen
223-
* Dayle Larson
224-
* Yasuo Honda
225-
* Yavor Nikolov
195+
Thanks to everyone who has contributed to ruby-plsql over the years. The up-to-date list is maintained on GitHub: https://github.com/rsim/ruby-plsql/graphs/contributors
226196

227197
LICENSE
228198
-------

0 commit comments

Comments
 (0)