Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

53 lines (32 loc) · 1.56 KB

Contributing

Developing

If you'd like to submit a patch:

  1. Fork the project.
  2. Make your feature addition or bug fix.
  3. Add tests for it. This is important so that it isn't broken in a future version unintentionally.
  4. Commit. Do not touch any unrelated code, such as the gemspec or version. If you must change unrelated code, do it in a commit by itself, so that it can be ignored.
  5. Send a pull request.

Testing

Install prerequisites

Install git and mercurial on your test system. (http://mercurial.selenic.com/wiki/Download)

Install the latest version of Bundler

$ gem install bundler

Clone the project

$ git clone git://github.com/berkshelf/berkshelf.git

and run:

$ cd berkshelf
$ bundle install

Bundler will install all gems and their dependencies required for testing and developing.

Running unit (RSpec) and acceptance (Cucumber) tests

We use Chef Zero - an in-memory Chef Server for running tests. It is automatically managed by the Specs and Cukes. Simply run:

$ bundle exec guard start

See here for a quick way to get a testing chef server up.

Debugging Issues

By default, Berkshelf will only give you the top-level output from a failed command. If you're working deep inside the core, an error like:

Berkshelf Error: wrong number of arguments (2 for 1)

isn't exactly helpful...

Specify the BERKSHELF_DEBUG flag when running your command to see a full stack trace and other helpful debugging information.