You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+19-3Lines changed: 19 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,16 +3,27 @@ CONTRIBUTING
3
3
4
4
# General
5
5
* 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
+
6
17
7
18
## Licensing
8
19
* All Cookbooks must be Apache 2.0 licensed.
9
20
* 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)
11
22
* If you've forked the cookbook from another repo, please add notes attributing the original work to that repo
12
23
13
24
## README.md / Documentation
14
25
* 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.
16
27
17
28
## CHANGELOG.md
18
29
* Please include a `CHANGELOG.md` in the cookbook root directory
@@ -27,13 +38,18 @@ CONTRIBUTING
27
38
28
39
## test-kitchen support
29
40
* 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
+
*
30
43
31
44
### test-kitchen structure
32
45
* 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.
34
47
35
48
## foodcritic
36
49
* TODO: Add notes regarding foodcritic
50
+
*
51
+
52
+
## chefspec/serverspec/minitest
37
53
38
54
# Code Review
39
55
* All code additions and pull requests are subject to the following:
0 commit comments