Skip to content

Commit 529acdf

Browse files
committed
Update CONTRIBUTING.md
1 parent 81b8e2d commit 529acdf

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,27 @@ CONTRIBUTING
33

44
# General
55
* The following document will serve as a guide on what and how to contribute to any cookbook within [rackspace-cookbooks](https://github.com/rackspace-cookbooks/).
6+
* The cookbookname, attribute namespace and git repo should all have the same name
7+
* i.e. rackspace_yum
8+
9+
## Attributes
10+
* All attributes should by ruby symbols instead of strings
11+
* i.e. `default[:rackspace_apache]` instead of `default['apache']`
12+
* All Attributes namespace should match the cookbook name
13+
* i.e. `default[:rackspace_user]`
14+
* All Attributes that will be written a configuration file must fall under a [:config] hash
15+
* i.e. `default[:rackspace_apache][:config]`
16+
617

718
## Licensing
819
* All Cookbooks must be Apache 2.0 licensed.
920
* Include a `LICENSE` file in the top level directory of the cookbook with the Apache 2.0 Official license
10-
* Include a `License and Authors` section of the `README.md`. See example at [chef-client](https://github.com/rackspace-cookbooks/chef-client)
21+
* Include a `License and Authors` section of the `README.md`. See example at [rackspace-user](https://github.com/rackspace-cookbooks/rackspace-user)
1122
* If you've forked the cookbook from another repo, please add notes attributing the original work to that repo
1223

1324
## README.md / Documentation
1425
* Please include a README.md file in the cookbook root directory.
15-
* Please include Descriptions, Platform support, notes, nots on recipes, attributes, etc
26+
* Please include Descriptions, Platform support, notes, nots on recipes, attributes, CONTRIBUTING and testing specifications.
1627

1728
## CHANGELOG.md
1829
* Please include a `CHANGELOG.md` in the cookbook root directory
@@ -27,13 +38,18 @@ CONTRIBUTING
2738

2839
## test-kitchen support
2940
* test-kitchen 1.0 support is required for all cookbooks. Please see [test-kitchen](https://github.com/opscode/test-kitchen) for more details.
41+
* test-kitchen should include platforms for
42+
*
3043

3144
### test-kitchen structure
3245
* Tests should be handled as a sub cookbook under /test/cookbooks/$name_test similar to how the opscode [chef-client](https://github.com/rackspace-cookbooks/chef-client) cookbook is layed out.
33-
* The tests should be called and have any needed attributes set in a .kitchen.yml file with seperate suites as appropiate. We will append our own .kitchen.local.yml that provides kitchen-openstack support for our own testing.
46+
* The tests should be called and have any needed attributes set in a .kitchen.yml file with seperate suites as appropiate. We will append our own .kitchen.local.yml via branch `testint` that provides kitchen-openstack support for our testing against openstack.
3447

3548
## foodcritic
3649
* TODO: Add notes regarding foodcritic
50+
*
51+
52+
## chefspec/serverspec/minitest
3753

3854
# Code Review
3955
* All code additions and pull requests are subject to the following:

0 commit comments

Comments
 (0)