Skip to content

Commit 1194b14

Browse files
committed
Move CI into CONTRIBUTING
1 parent 5e521f1 commit 1194b14

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
@@ -1097,64 +1097,6 @@ Most notable improvements:
10971097

10981098
Ruby 2.7 and higher is supported.
10991099

1100-
## Development
1100+
## Contributing
11011101

1102-
Contributions are welcome. Make sure to read our [development guide](./DEVELOPMENT.md).
1103-
1104-
## Continuous integration
1105-
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.
1106-
We use RSpec and Github Actions to test our infrastructure around the clock, and that includes all changes to our clients.
1107-
1108-
The directory spec/ includes specification which serves the dual purposes of examples and functional tests.
1109-
1110-
Set your secret API key in your shell before running a test.
1111-
The SerpApi key can be obtained from [serpapi.com/signup](https://serpapi.com/users/sign_up?plan=free).
1112-
```bash
1113-
export SERPAPI_KEY="your_secret_key"
1114-
```
1115-
Install testing dependency
1116-
```bash
1117-
$ bundle install
1118-
# or
1119-
$ rake dependency
1120-
```
1121-
1122-
Check code quality using Lint.
1123-
```bash
1124-
$ rake lint
1125-
```
1126-
1127-
Run basic test
1128-
```bash
1129-
$ rake test
1130-
```
1131-
1132-
Run tests with code coverage
1133-
```bash
1134-
$ rake coverage
1135-
```
1136-
1137-
Review coverage report generated by `rake coverage`
1138-
```sh
1139-
# Current coverage: 98.68% (75 / 76 lines)
1140-
open coverage/index.html
1141-
```
1142-
1143-
Review documentation generated by `rake doc`
1144-
```sh
1145-
open doc/index.html
1146-
```
1147-
1148-
Run full regression test suite on the examples.
1149-
```bash
1150-
rake regression
1151-
```
1152-
1153-
Test the actuall packaged gem locally using the demo scripts.
1154-
```bash
1155-
$ rake oobt
1156-
```
1157-
1158-
Open ./Rakefile for more information.
1159-
1160-
Contributions are welcome. Feel free to submit a pull request!
1102+
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
@@ -582,61 +582,3 @@ Ruby 2.7 and higher is supported.
582582
* [2025-11-17] 1.0.2 Implement `inspect` functions for client
583583
* [2025-07-18] 1.0.1 Add support for old Ruby versions (2.7, 3.0)
584584
* [2025-07-01] 1.0.0 Full API support
585-
586-
## Continuous integration
587-
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.
588-
We use RSpec and Github Actions to test our infrastructure around the clock, and that includes all changes to our clients.
589-
590-
The directory spec/ includes specification which serves the dual purposes of examples and functional tests.
591-
592-
Set your secret API key in your shell before running a test.
593-
The SerpApi key can be obtained from [serpapi.com/signup](https://serpapi.com/users/sign_up?plan=free).
594-
```bash
595-
export SERPAPI_KEY="your_secret_key"
596-
```
597-
Install testing dependency
598-
```bash
599-
$ bundle install
600-
# or
601-
$ rake dependency
602-
```
603-
604-
Check code quality using Lint.
605-
```bash
606-
$ rake lint
607-
```
608-
609-
Run basic test
610-
```bash
611-
$ rake test
612-
```
613-
614-
Run tests with code coverage
615-
```bash
616-
$ rake coverage
617-
```
618-
619-
Review coverage report generated by `rake coverage`
620-
```sh
621-
# Current coverage: 98.68% (75 / 76 lines)
622-
open coverage/index.html
623-
```
624-
625-
Review documentation generated by `rake doc`
626-
```sh
627-
open doc/index.html
628-
```
629-
630-
Run full regression test suite on the examples.
631-
```bash
632-
rake regression
633-
```
634-
635-
Test the actuall packaged gem locally using the demo scripts.
636-
```bash
637-
$ rake oobt
638-
```
639-
640-
Open ./Rakefile for more information.
641-
642-
Contributions are welcome. Feel free to submit a pull request!

0 commit comments

Comments
 (0)