CONTRIBUTING.md in google-cloud-env-1.4.0 vs CONTRIBUTING.md in google-cloud-env-1.5.0
- old
+ new
@@ -1,110 +1,71 @@
-# Contributing to Google Cloud hosting environment
+# Contributing to Google Cloud Ruby Client
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):
+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).
+- **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.
+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-env console and run the project's tests,
-there is a small amount of setup:
+In order to use the google-cloud-ruby console and run the project's tests, there is a
+small amount of setup:
-1. Install Ruby. google-cloud-env requires Ruby 2.4+. 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).
+1. Install Ruby.
+ google-cloud-env requires Ruby 2.4+. 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/).
+2. Install [Bundler](http://bundler.io/).
- ```sh
- $ gem install bundler
- ```
+ ```sh
+ $ gem install bundler
+ ```
-3. Install the top-level project dependencies.
+3. Install the project dependencies.
- ```sh
- $ bundle install
- ```
+ ```sh
+ $ bundle install
+ ```
-4. Install the hosting environment dependencies.
+## Tests
- ```sh
- $ cd google-cloud-env/
- $ bundle exec rake bundleupdate
- ```
+All contributions should include tests that ensure the contributed code behaves as expected.
-## hosting environment Tests
+To run the tests and code style checks together:
-Tests are very important part of google-cloud-env. 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-env/
$ bundle exec rake ci
```
-To run the command above, plus all acceptance tests, use `rake ci:acceptance` or
-its handy alias, `rake ci:a`.
+### Unit Tests
-### hosting environment 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 unit tests for a package:
-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 hosting environment unit tests:
-
``` sh
-$ cd google-cloud-env/
$ bundle exec rake test
```
-### hosting environment Documentation Tests
+### Coding Style
-The project tests the code examples in the gem's
-[YARD](https://github.com/lsegal/yard)-based documentation.
+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:
-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).
+* Avoid parenthesis when possible, including in method definitions.
+* Always use double quotes strings. ([Option B](https://github.com/bbatsov/ruby-style-guide#strings))
-To run the hosting environment documentation tests:
+You can check your code against these rules by running Rubocop like so:
-``` sh
-$ cd google-cloud-env/
-$ bundle exec rake doctest
+```sh
+$ bundle exec rake rubocop
```
-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.
-
## 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.
+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 [Code of Conduct](CODE_OF_CONDUCT.md) for more information.