Please submit improvements and bug fixes via Github pull requests or by sending an email to firstname.lastname@example.org in git's format-patch format.
All patches should have well-written commit message. The first line should summarize the change while the rest of the commit message should explain the reason the change is needed.
Please ensure all tests and lint checking pass before submitting pull requests.
Testing & Development
This cookbook uses a variety of testing components:
- Unit tests: ChefSpec
- Integration tests: Test Kitchen
- Chef Style lints: Foodcritic
- Ruby Style lints: Rubocop
To develop on this cookbook, you must have a sane Ruby 1.9+ environment. Given the nature of this installation process (and it's variance across multiple operating systems), we will leave this installation process to the user.
You must also have
$ gem install bundler
You must also have Vagrant and VirtualBox installed:
Once installed, you must install the
$ vagrant plugin install vagrant-berkshelf
Clone the git repository from GitHub:
$ git clone email@example.com:stevendanna/tmux.git
Install the dependencies using bundler:
$ bundle install
Create a branch for your changes:
$ git checkout -b my_bug_fix
Make your desired changes.
Write tests to support those changes. It is recommended you write both unit and integration tests.
Run the tests:
bundle exec rspec
bundle exec foodcritic .
bundle exec rubocop
bundle exec kitchen test
Assuming the tests pass, open a Pull Request on GitHub or send a git format-patch to firstname.lastname@example.org.