Skip to content
This repository has been archived by the owner on Sep 30, 2022. It is now read-only.

Latest commit

 

History

History
174 lines (148 loc) · 6.56 KB

CONTRIBUTING.md

File metadata and controls

174 lines (148 loc) · 6.56 KB

How to become a contributor and submit your own code

Contributor License Agreements

We'd love to accept your sample apps and patches! Before we can take them, we have to jump a couple of legal hurdles.

Please fill out either the individual or corporate Contributor License Agreement (CLA).

Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests.

Contributing A Patch

  1. Submit an issue describing your proposed change to the repo in question.
  2. The repo owner will respond to your issue promptly.
  3. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
  4. Fork the desired repo, develop and test your code changes.
  5. Ensure that your code adheres to the existing style in the sample to which you are contributing.
  6. Ensure that your code has an appropriate set of unit tests which all pass.
  7. Submit a pull request.

Style

We adhere as much as possible to the ruby-style-guide and make the code rubocop compliant. Tests are setup to fail if there are style guide violations.

Testing

Please make sure all tests pass before sending a patch. This will help us to approve your change faster.

As a matter of policy the master branch is always passing all tests, and changes that break tests cannot be accepted. If that's your case reach out and we can help you get it fixed.

Running Tests

gem install bundler
bundle install
bundle exec rspec
bundle exec rubocop

Auto generated files

Various of the files in this repository are automatically generated by chef-codegen. Such files contain a prominent comment warning for its auto generated origins. However some types, such as JSON or MD, do not allow embedding comments without breaking the file or causing side effects.

Changing auto generated files

Of course these files are not perfect there will inevitably be issues with them. If you find an issue with them there are 2 options:

  1. Send a patch to the affected files to us and we'll update the source used to generate the file, thus addressing the issue. Note that in this option your patch will not be accepted but will be used as a guide to fix the original file.

  2. Change the file directly in the sources used by chef-codegen. By taking this approach your change will be attributed to you, as you'd be the author of the change. If you'd like to take credit for the change this is the recommended approach. This approach has the nice side effect to fix all other projects that have the same issue at once.

File list

The list below contains all the files that were automatically generated by chef-codegen:

  • .gitignore
  • .rubocop.yml
  • Berksfile
  • CHANGELOG.md
  • chefignore
  • CONTRIBUTING.md
  • Gemfile
  • libraries/init.rb
  • libraries/google/container/network/base.rb
  • libraries/google/container/network/delete.rb
  • libraries/google/container/network/get.rb
  • libraries/google/container/network/post.rb
  • libraries/google/container/network/put.rb
  • libraries/google/container/property/array.rb
  • libraries/google/container/property/boolean.rb
  • libraries/google/container/property/cluster_addons_config.rb
  • libraries/google/container/property/cluster_horizontal_pod_autoscaling.rb
  • libraries/google/container/property/cluster_http_load_balancing.rb
  • libraries/google/container/property/cluster_master_auth.rb
  • libraries/google/container/property/cluster_name.rb
  • libraries/google/container/property/cluster_node_config.rb
  • libraries/google/container/property/enum.rb
  • libraries/google/container/property/integer.rb
  • libraries/google/container/property/namevalues.rb
  • libraries/google/container/property/nodepool_autoscaling.rb
  • libraries/google/container/property/nodepool_config.rb
  • libraries/google/container/property/nodepool_management.rb
  • libraries/google/container/property/nodepool_upgrade_options.rb
  • libraries/google/container/property/string.rb
  • libraries/google/container/property/string_array.rb
  • libraries/google/container/property/time.rb
  • metadata.rb
  • README.md
  • recipes/examples~cluster.rb
  • recipes/examples~delete_cluster.rb
  • recipes/examples~delete_node_pool.rb
  • recipes/examples~kube_config.rb
  • recipes/examples~node_pool.rb
  • recipes/README.md
  • recipes/tests~cluster.rb
  • recipes/tests~delete_cluster.rb
  • recipes/tests~delete_node_pool.rb
  • recipes/tests~kube_config.rb
  • recipes/tests~node_pool.rb
  • resources/cluster.rb
  • resources/kube_config.rb
  • resources/node_pool.rb
  • spec/bundle.rb
  • spec/cluster_spec.rb
  • spec/cookbooks/google-gauth/metadata.rb
  • spec/data/network/gcontainer_cluster/success1~name.yaml
  • spec/data/network/gcontainer_cluster/success1~title.yaml
  • spec/data/network/gcontainer_cluster/success2~name.yaml
  • spec/data/network/gcontainer_cluster/success2~title.yaml
  • spec/data/network/gcontainer_cluster/success3~name.yaml
  • spec/data/network/gcontainer_cluster/success3~title.yaml
  • spec/data/network/gcontainer_node_pool/success1~name.yaml
  • spec/data/network/gcontainer_node_pool/success1~title.yaml
  • spec/data/network/gcontainer_node_pool/success2~name.yaml
  • spec/data/network/gcontainer_node_pool/success2~title.yaml
  • spec/data/network/gcontainer_node_pool/success3~name.yaml
  • spec/data/network/gcontainer_node_pool/success3~title.yaml
  • spec/fake_auth.rb
  • spec/fake_cred.rb
  • spec/foodcritic_spec.rb
  • spec/kube_config_spec.rb
  • spec/network_blocker.rb
  • spec/network_blocker_spec.rb
  • spec/network_delete_spec.rb
  • spec/network_get_spec.rb
  • spec/network_post_spec.rb
  • spec/network_put_spec.rb
  • spec/node_pool_spec.rb
  • spec/spec_helper.rb
  • spec/test_constants.rb

The list below contains all the files that were automatically sourced from a central location:

  • Gemfile.lock
  • libraries/google/hash_utils.rb
  • libraries/google/string_utils.rb
  • LICENSE
  • spec/data/poor_recipe.rb
  • spec/hash_utils_spec.rb
  • spec/string_utils_spec.rb