1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
# Contributing to Google Cloud
1. **Sign one of the contributor license agreements below.**
2. Fork the repo, develop and test your code changes.
3. Send a pull request.
## Contributor License Agreements
Before we can accept your pull requests you'll need to sign a Contributor
License Agreement (CLA):
- **If you are an individual writing original source code** and **you own the
intellectual property**, then you'll need to sign an [individual
CLA](https://developers.google.com/open-source/cla/individual).
- **If you work for a company that wants to allow you to contribute your work**,
then you'll need to sign a [corporate
CLA](https://developers.google.com/open-source/cla/corporate).
You can sign these electronically (just scroll to the bottom). After that, we'll
be able to accept your pull requests.
## Setup
In order to use the google-cloud console and run the project's tests,
there is a small amount of setup:
1. Install Ruby. google-cloud requires Ruby 2.5+. You may choose to
manage your Ruby and gem installations with [RVM](https://rvm.io/),
[rbenv](https://github.com/rbenv/rbenv), or
[chruby](https://github.com/postmodern/chruby).
2. Install [Bundler](http://bundler.io/).
```sh
$ gem install bundler
```
3. Install the top-level project dependencies.
```sh
$ bundle install
```
4. Install the Google Cloud dependencies.
```sh
$ cd google-cloud-errors/
$ bundle install
```
## Google Cloud Tests
Tests are very important part of google-cloud. All contributions
should include tests that ensure the contributed code behaves as expected.
To run the unit tests, documentation tests, and code style checks together for a
package:
``` sh
$ cd google-cloud-errors/
$ bundle exec rake ci
```
To run the command above, plus all acceptance tests, use `rake ci:acceptance` or
its handy alias, `rake ci:a`.
### Google Cloud Unit Tests
The project uses the [minitest](https://github.com/seattlerb/minitest) library,
including [specs](https://github.com/seattlerb/minitest#specs),
[mocks](https://github.com/seattlerb/minitest#mocks) and
[minitest-autotest](https://github.com/seattlerb/minitest-autotest).
To run the Google Cloud unit tests:
``` sh
$ cd google-cloud-errors/
$ bundle exec rake test
```
### Google Cloud Documentation Tests
The project tests the code examples in the gem's
[YARD](https://github.com/lsegal/yard)-based documentation.
The example testing functions in a way that is very similar to unit testing, and
in fact the library providing it,
[yard-doctest](https://github.com/p0deje/yard-doctest), is based on the
project's unit test library, [minitest](https://github.com/seattlerb/minitest).
To run the Google Cloud documentation tests:
``` sh
$ cd google-cloud-errors/
$ bundle exec rake doctest
```
If you add, remove or modify documentation examples when working on a pull
request, you may need to update the setup for the tests. The stubs and mocks
required to run the tests are located in `support/doctest_helper.rb`. Please
note that much of the setup is matched by the title of the
[`@example`](http://www.rubydoc.info/gems/yard/file/docs/Tags.md#example) tag.
If you alter an example's title, you may encounter breaking tests.
## Coding Style
Please follow the established coding style in the library. The style is is
largely based on [The Ruby Style
Guide](https://github.com/bbatsov/ruby-style-guide) with a few exceptions based
on seattle-style:
* Avoid parenthesis when possible, including in method definitions.
* Always use double quotes strings. ([Option
B](https://github.com/bbatsov/ruby-style-guide#strings))
You can check your code against these rules by running Rubocop like so:
```sh
$ cd google-cloud-errors/
$ bundle exec rake rubocop
```
## Code of Conduct
Please note that this project is released with a Contributor Code of Conduct. By
participating in this project you agree to abide by its terms. See {file:CODE_OF_CONDUCT.md Code of Conduct} for more information.
|
