1
- # Contributing to Opscode Cookbooks
1
+ # Contributing to Chef Software Cookbooks
2
2
3
- We are glad you want to contribute to Opscode Cookbooks! The first
3
+ We are glad you want to contribute to Chef Software Cookbooks! The first
4
4
step is the desire to improve the project.
5
5
6
6
You can find the answers to additional frequently asked questions
7
- [ on the wiki] ( http://wiki.opscode.com /display/chef/How+to+Contribute ) .
7
+ [ on the wiki] ( http://wiki.chef.io /display/chef/How+to+Contribute ) .
8
8
9
9
You can find additional information about
10
- [ contributing to cookbooks] ( http://wiki.opscode.com /display/chef/How+to+Contribute+to+Opscode +Cookbooks )
10
+ [ contributing to cookbooks] ( http://wiki.chef.io /display/chef/How+to+Contribute+to+Chef +Cookbooks )
11
11
on the wiki as well.
12
12
13
13
## Quick-contribute
14
14
15
- * Create an account on our [ bug tracker] ( http://tickets.opscode.com )
15
+ * Create an account on our [ bug tracker] ( http://tickets.chef.io )
16
16
* Sign our contributor agreement (CLA)
17
17
[ online] ( https://secure.echosign.com/public/hostedForm?formid=PJIF5694K6L )
18
18
(keep reading if you're contributing on behalf of your employer)
19
19
* Create a ticket for your change on the
20
- [ bug tracker] ( http://tickets.opscode.com )
20
+ [ bug tracker] ( http://tickets.chef.io )
21
21
* Link to your patch as a rebased git branch or pull request from the
22
22
ticket
23
23
* Resolve the ticket as fixed
@@ -39,7 +39,7 @@ understands what rights they are licensing and agrees to them.
39
39
Sometimes the copyright holder isn't the contributor, most often when
40
40
the contributor is doing work for a company.
41
41
42
- To make a good faith effort to ensure these criteria are met, Opscode
42
+ To make a good faith effort to ensure these criteria are met, Chef
43
43
requires a Contributor License Agreement (CLA) or a Corporate
44
44
Contributor License Agreement (CCLA) for all contributions. This is
45
45
without exception due to some matters not being related to copyright
@@ -58,7 +58,7 @@ instead.
58
58
59
59
## Ticket Tracker (JIRA)
60
60
61
- The [ ticket tracker] ( http://tickets.opscode.com ) is the most important
61
+ The [ ticket tracker] ( http://tickets.chef.io ) is the most important
62
62
documentation for the code base. It provides significant historical
63
63
information, such as:
64
64
@@ -72,7 +72,7 @@ Each ticket should aim to fix one bug or add one feature.
72
72
73
73
You can get a quick copy of the repository for this cookbook by
74
74
running `git clone
75
- git://github.com/opscode -coobkooks/COOKBOOKNAME.git`.
75
+ git://github.com/chef -coobkooks/COOKBOOKNAME.git`.
76
76
77
77
For collaboration purposes, it is best if you create a Github account
78
78
and fork the repository to your own account. Once you do this you will
@@ -109,8 +109,8 @@ to them.
109
109
110
110
### Github and Pull Requests
111
111
112
- All of Opscode 's open source cookbook projects are available on
113
- [ Github] ( http://www.github.com/opscode -cookbooks ) .
112
+ All of Chef 's open source cookbook projects are available on
113
+ [ Github] ( http://www.github.com/chef -cookbooks ) .
114
114
115
115
We don't require you to use Github, and we will even take patch diffs
116
116
attached to tickets on the tracker. However Github has a lot of
@@ -127,18 +127,18 @@ reply from the author for various reasons.
127
127
### More information
128
128
129
129
Additional help with git is available on the
130
- [ Working with Git] ( http://wiki.opscode.com /display/chef/Working+with+Git )
130
+ [ Working with Git] ( http://wiki.chef.io /display/chef/Working+with+Git )
131
131
wiki page.
132
132
133
133
## Functional and Unit Tests
134
134
135
135
This cookbook is set up to run tests under
136
- [ Opscode 's test-kitchen] ( https://github.com/opscode /test-kitchen ) . It
136
+ [ Chef 's test-kitchen] ( https://github.com/chef /test-kitchen ) . It
137
137
uses minitest-chef to run integration tests after the node has been
138
138
converged to verify that the state of the node.
139
139
140
140
Test kitchen should run completely without exception using the default
141
- [ baseboxes provided by Opscode ] ( https://github.com/opscode /bento ) .
141
+ [ baseboxes provided by Chef ] ( https://github.com/chef /bento ) .
142
142
Because Test Kitchen creates VirtualBox machines and runs through
143
143
every configuration in the Kitchenfile, it may take some time for
144
144
these tests to complete.
@@ -168,7 +168,7 @@ mailing list, or the #chef-hacking IRC channel.
168
168
169
169
## Code Review
170
170
171
- Opscode regularly reviews code contributions and provides suggestions
171
+ Chef Software regularly reviews code contributions and provides suggestions
172
172
for improvement in the code itself or the implementation.
173
173
174
174
We find contributions by searching the ticket tracker for _ resolved_
@@ -183,7 +183,7 @@ or two, depending on the current release cycle.
183
183
184
184
## Release Cycle
185
185
186
- The versioning for Opscode Cookbook projects is X.Y.Z.
186
+ The versioning for Chef Software Cookbook projects is X.Y.Z.
187
187
188
188
* X is a major release, which may not be fully compatible with prior
189
189
major releases
@@ -196,31 +196,31 @@ cookbook begins, the "Z" patch number is incremented to the next odd
196
196
number, however the next release of the cookbook may be a major or
197
197
minor incrementing version.
198
198
199
- Releases of Opscode 's cookbooks are usually announced on the Chef user
199
+ Releases of Chef 's cookbooks are usually announced on the Chef user
200
200
mailing list. Releases of several cookbooks may be batched together
201
- and announced on the [ Opscode Blog] ( http://www.opscode.com /blog ) .
201
+ and announced on the [ Chef Software Blog] ( http://www.chef.io /blog ) .
202
202
203
203
## Working with the community
204
204
205
205
These resources will help you learn more about Chef and connect to
206
206
other members of the Chef community:
207
207
208
- * [ chef] ( http://lists.opscode.com /sympa/info/chef ) and
209
- [ chef-dev] ( http://lists.opscode.com /sympa/info/chef-dev ) mailing
208
+ * [ chef] ( http://lists.chef.io /sympa/info/chef ) and
209
+ [ chef-dev] ( http://lists.chef.io /sympa/info/chef-dev ) mailing
210
210
lists
211
211
* #chef and #chef-hacking IRC channels on irc.freenode.net
212
- * [ Community Cookbook site] ( http://community.opscode.com )
213
- * [ Chef wiki] ( http://wiki.opscode.com /display/chef )
214
- * Opscode Chef [ product page] ( http://www.opscode.com /chef )
212
+ * [ Community Cookbook site] ( http://community.chef.io )
213
+ * [ Chef wiki] ( http://wiki.chef.io /display/chef )
214
+ * Chef Software Chef [ product page] ( http://www.chef.io /chef )
215
215
216
216
217
217
## Cookbook Contribution Do's and Don't's
218
218
219
219
Please do include tests for your contribution. If you need help, ask
220
220
on the
221
- [ chef-dev mailing list] ( http://lists.opscode.com /sympa/info/chef-dev )
221
+ [ chef-dev mailing list] ( http://lists.chef.io /sympa/info/chef-dev )
222
222
or the
223
- [ #chef-hacking IRC channel] ( http://community.opscode.com /chat/chef-hacking ) .
223
+ [ #chef-hacking IRC channel] ( http://community.chef.io /chat/chef-hacking ) .
224
224
Not all platforms that a cookbook supports may be supported by Test
225
225
Kitchen. Please provide evidence of testing your contribution if it
226
226
isn't trivial so we don't have to duplicate effort in testing. Chef
@@ -247,11 +247,11 @@ Please do ensure that your changes do not break or modify behavior for
247
247
other platforms supported by the cookbook. For example if your changes
248
248
are for Debian, make sure that they do not break on CentOS.
249
249
250
- Please do not modify the version number in the metadata.rb, Opscode
250
+ Please do not modify the version number in the metadata.rb, Chef
251
251
will select the appropriate version based on the release cycle
252
252
information above.
253
253
254
254
Please do not update the CHANGELOG.md for a new version. Not all
255
255
changes to a cookbook may be merged and released in the same versions.
256
- Opscode will update the CHANGELOG.md when releasing a new version of
256
+ Chef Software will update the CHANGELOG.md when releasing a new version of
257
257
the cookbook.
0 commit comments