Sha256: f4dc9d2a3cb9c1e0821941ca9df83894292cc546545f8913a2415f34aa8df8e2

Contents?: true

Size: 1.28 KB

Versions: 53

Compression:

Stored size: 1.28 KB

Contents

# Contributing

## Add new resource type (ex. Redshift resource)

1. Create your feature branch (`git checkout -b add-type-redshift`)
2. Generate template files (`bundle exec bin/toolbox template redshift`)
3. Fill files with code.
4. Generate [doc/resource_types.md](doc/resource_types.md) (`bundle exec bin/toolbox docgen > doc/resource_types.md`)
5. Run test (`bundle exec rake spec`)
6. Push to the branch (`git push origin add-type-redshift`)
7. Create a new Pull Request

## Add new account attribute type (ex. CloudFormation::Client#describe_account_attributes )

1. Create your feature branch (`git checkout -b add-type-cf-limit`)
2. Generate template files (`bundle exec bin/toolbox template cloudformation_account_attributes -a`) **with -a option**
3. Fill files with code.
4. Generate [doc/resource_types.md](doc/resource_types.md) (`bundle exec bin/toolbox docgen > doc/resource_types.md`)
5. Run test (`bundle exec rake spec`)
6. Push to the branch (`git push origin add-type-redshift`)
7. Create a new Pull Request

## Append resource type document (ex. VPC resource `be_available`)

1. Create vpc.md (`touch doc/_resource_types/vpc.md`)
2. Write following document.

<pre>
### be_available
(Write cool description)
```ruby
describe vpc('my-vpc') do
   it { should be_available }
end
```
</pre>

Version data entries

53 entries across 53 versions & 2 rubygems

Version Path
awspec-1.5.0 doc/contributing.md
awspec-1.4.3 doc/contributing.md
awspec-1.4.2 doc/contributing.md
awspec-1.4.1 doc/contributing.md
awspec-1.4.0 doc/contributing.md
awspec-1.3.1 doc/contributing.md
awspec-1.3.0 doc/contributing.md
awspec-1.2.0 doc/contributing.md
awspec-1.1.0 doc/contributing.md
awspec-1.0.0 doc/contributing.md
awspec-1.0.0.rc doc/contributing.md
awspec-0.88.2 doc/contributing.md
awspec-0.88.1 doc/contributing.md
awspec-0.88.0 doc/contributing.md
awspec-0.87.1 doc/contributing.md
awspec-0.87.0 doc/contributing.md
awspec-0.86.0 doc/contributing.md
cmonson_2ndwatch_awspec-0.85.4 doc/contributing.md
awspec-0.85.3 doc/contributing.md
cmonson_2ndwatch_awspec-0.85.3 doc/contributing.md