Skip to content

Latest commit

 

History

History
87 lines (61 loc) · 3.22 KB

CONTRIBUTING.md

File metadata and controls

87 lines (61 loc) · 3.22 KB
Raw

Contributing

You can contribute to the Albacore framework in many ways.

Overview

Start by forking the repository. Make your changes in the dev branch (or a feature branch, whichever you're most comfortable with). Make sure to add or edit tests, as necessary. Submit your pull request to the Albacore/albacore dev branch. You will be notified by Travis, our servant, whether your pull request passes all tests. When the code has been reviewed and merged, it will be included in the next gem.

Be sure to set your line-endings correctly for your platform, before you start developing.

Building the Albacore Package

tl;dr

cmd> git clone git://github.com/Albacore/albacore.git -b dev
cmd> gem install bundler
cmd> bundle
cmd> rake install

The full instructions for building the Albacore package should be similar to other Github and Ruby gem projects. Fork or clone the Albacore/albacore repository and immediately use the dev branch.

cmd> git clone git://github.com/Albacore/albacore.git -b dev

You need the Bundler gem to install all of the Albacore development and runtime dependencies.

cmd> gem install bundler

If you are developing on the Windows platform, you will also need the RubyInstaller Development Kit (DevKit). There are complicated manual install instructions, but we recommend using the DevKit package from Chocolatey. Then, you can ask Bundler to install the dependencies listed in the Gemfile and albacore.gemspec.

cmd> bundle install

You can build the Albacore .gem package using the built-in rake task.

cmd> rake build

And you may install that same gem on your local system

cmd> gem install --local path/to/albacore.x.y.z.gem

Or, you can build & install in one step

cmd> rake install

Running Tests with RSpec

You can get a list of the available spec categories by running rake -T, they start with specs:. The specs:all task will run all of the specs. You can colorize the spec run output on your console with RSpec ~>2.7 and ansicon. We recommend installing the ansicon package using the Chocolatey package manager.

cmd> rake specs:all

The NCover and NDepend specs categories require a valid license to be installed on your system or they will fail. You can ignore those failures or run the special specs category specs:except_ncover.