Skip to content

Commit 5cf5cbe

Browse files
committed
Move CI into CONTRIBUTING
1 parent 4be4bf4 commit 5cf5cbe

File tree

3 files changed

+59
-118
lines changed

3 files changed

+59
-118
lines changed

CONTRIBUTING.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,60 @@ This project source code and coding style was inspired by the most awesome Ruby
2727
- 0 lint offense: `rake lint`
2828
- 100% tests passing: `rake test`
2929
- 100% code coverage: `rake coverage` (simple-cov)
30+
31+
## Continuous integration
32+
33+
We love [continuous integration](https://en.wikipedia.org/wiki/Continuous_integration) (CI) and [Test-Driven Development](https://en.wikipedia.org/wiki/Test-driven_development) (TDD) at SerpApi.
34+
We use RSpec and Github Actions to test our infrastructure around the clock, and that includes all changes to our clients.
35+
36+
The directory spec/ includes specification which serves the dual purposes of examples and functional tests.
37+
38+
Set your secret API key in your shell before running a test.
39+
The SerpApi key can be obtained from [serpapi.com/signup](https://serpapi.com/users/sign_up?plan=free).
40+
```bash
41+
export SERPAPI_KEY="your_secret_key"
42+
```
43+
Install testing dependency
44+
```bash
45+
$ bundle install
46+
# or
47+
$ rake dependency
48+
```
49+
50+
Check code quality using Lint.
51+
```bash
52+
$ rake lint
53+
```
54+
55+
Run basic test
56+
```bash
57+
$ rake test
58+
```
59+
60+
Run tests with code coverage
61+
```bash
62+
$ rake coverage
63+
```
64+
65+
Review coverage report generated by `rake coverage`
66+
```sh
67+
# Current coverage: 98.68% (75 / 76 lines)
68+
open coverage/index.html
69+
```
70+
71+
Review documentation generated by `rake doc`
72+
```sh
73+
open doc/index.html
74+
```
75+
76+
Run full regression test suite on the examples.
77+
```bash
78+
rake regression
79+
```
80+
81+
Test the actuall packaged gem locally using the demo scripts.
82+
```bash
83+
$ rake oobt
84+
```
85+
86+
Open ./Rakefile for more information.

README.md

Lines changed: 2 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1099,64 +1099,6 @@ Ruby versions validated by Github Actions:
10991099
- 3.4
11001100
* doc: [Github Actions.](https://github.com/serpapi/serpapi-ruby/actions/workflows/ci.yml)
11011101

1102-
## Development
1102+
## Contributing
11031103

1104-
Contributions are welcome. Make sure to read our [development guide](./DEVELOPMENT.md).
1105-
1106-
## Continuous integration
1107-
We love [continuous integration](https://en.wikipedia.org/wiki/Continuous_integration) (CI) and [Test-Driven Development](https://en.wikipedia.org/wiki/Test-driven_development) (TDD) at SerpApi.
1108-
We use RSpec and Github Actions to test our infrastructure around the clock, and that includes all changes to our clients.
1109-
1110-
The directory spec/ includes specification which serves the dual purposes of examples and functional tests.
1111-
1112-
Set your secret API key in your shell before running a test.
1113-
The SerpApi key can be obtained from [serpapi.com/signup](https://serpapi.com/users/sign_up?plan=free).
1114-
```bash
1115-
export SERPAPI_KEY="your_secret_key"
1116-
```
1117-
Install testing dependency
1118-
```bash
1119-
$ bundle install
1120-
# or
1121-
$ rake dependency
1122-
```
1123-
1124-
Check code quality using Lint.
1125-
```bash
1126-
$ rake lint
1127-
```
1128-
1129-
Run basic test
1130-
```bash
1131-
$ rake test
1132-
```
1133-
1134-
Run tests with code coverage
1135-
```bash
1136-
$ rake coverage
1137-
```
1138-
1139-
Review coverage report generated by `rake coverage`
1140-
```sh
1141-
# Current coverage: 98.68% (75 / 76 lines)
1142-
open coverage/index.html
1143-
```
1144-
1145-
Review documentation generated by `rake doc`
1146-
```sh
1147-
open doc/index.html
1148-
```
1149-
1150-
Run full regression test suite on the examples.
1151-
```bash
1152-
rake regression
1153-
```
1154-
1155-
Test the actuall packaged gem locally using the demo scripts.
1156-
```bash
1157-
$ rake oobt
1158-
```
1159-
1160-
Open ./Rakefile for more information.
1161-
1162-
Contributions are welcome. Feel free to submit a pull request!
1104+
Contributions are welcome. Make sure to read our [contributing guide](./CONTRIBUTING.md).

README.md.erb

Lines changed: 0 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -584,61 +584,3 @@ Ruby versions validated by Github Actions:
584584
* [2025-11-17] 1.0.2 Implement `inspect` functions for client
585585
* [2025-07-18] 1.0.1 Add support for old Ruby versions (2.7, 3.0)
586586
* [2025-07-01] 1.0.0 Full API support
587-
588-
## Continuous integration
589-
We love [continuous integration](https://en.wikipedia.org/wiki/Continuous_integration) (CI) and [Test-Driven Development](https://en.wikipedia.org/wiki/Test-driven_development) (TDD) at SerpApi.
590-
We use RSpec and Github Actions to test our infrastructure around the clock, and that includes all changes to our clients.
591-
592-
The directory spec/ includes specification which serves the dual purposes of examples and functional tests.
593-
594-
Set your secret API key in your shell before running a test.
595-
The SerpApi key can be obtained from [serpapi.com/signup](https://serpapi.com/users/sign_up?plan=free).
596-
```bash
597-
export SERPAPI_KEY="your_secret_key"
598-
```
599-
Install testing dependency
600-
```bash
601-
$ bundle install
602-
# or
603-
$ rake dependency
604-
```
605-
606-
Check code quality using Lint.
607-
```bash
608-
$ rake lint
609-
```
610-
611-
Run basic test
612-
```bash
613-
$ rake test
614-
```
615-
616-
Run tests with code coverage
617-
```bash
618-
$ rake coverage
619-
```
620-
621-
Review coverage report generated by `rake coverage`
622-
```sh
623-
# Current coverage: 98.68% (75 / 76 lines)
624-
open coverage/index.html
625-
```
626-
627-
Review documentation generated by `rake doc`
628-
```sh
629-
open doc/index.html
630-
```
631-
632-
Run full regression test suite on the examples.
633-
```bash
634-
rake regression
635-
```
636-
637-
Test the actuall packaged gem locally using the demo scripts.
638-
```bash
639-
$ rake oobt
640-
```
641-
642-
Open ./Rakefile for more information.
643-
644-
Contributions are welcome. Feel free to submit a pull request!

0 commit comments

Comments
 (0)