Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.39 KB

contribute.md

File metadata and controls

37 lines (24 loc) · 1.39 KB

Contribute or Improving a Veewee Template

If you have a setup working, share your 'definition' with me. That would be fun!

How to add a new OS/installation

I suggest the easiest way is to get an account on Github.

Then fork the veewee repository to your account and clone it to your computer:

$ git clone https://github.com/*your account*/veewee.git
$ cd veewee
$ gem install bundler
$ bundle install

TODO ct 2013-02-4 Move this to "Requirements"?

If you don't use rvm, be sure to execute vagrant through bundle exec:

$ alias veewee="bundle exec veewee"

Start your new definition on base of an existing one by executing:

$ veewee vbox define 'mynewos' '<your_os_of_choice>'

Now follow these best practices:

  • Apply your changes in ./definitions/mynewos
  • Build it with veewee vbox build 'mynewos'
  • Validate with veewee vbox validate 'mynewos'
  • When it builds OK and all tests are green, move definition/mynewos to a sensible directory under templates Follow the naming schema of existing boxes
  • Commit the changes: git commit -a
  • Push the changes to github: git push
  • Go to the github gui and issue a pull request for it: https://github.com/*your account*/veewee/pull/new/master

TODO ct 2013-02-4 Bonuspoints for feature-branches and adding tests to verify new post installs?