== HACKING

=== Prerequisites

Install Ruby libraries necessary for development using <<Bundler>>:

------------------------------------------------------------------------------
bundle install
------------------------------------------------------------------------------

// TODO: list additional tools and libraries needed to develop your project

=== Infrastructure

<<Inochi>> serves as the project infrastructure for #{project_name}.  It
handles tasks such as building this help manual and API documentation, and
packaging, announcing, and publishing new releases.  See its help manual and
list of tasks to get started:

------------------------------------------------------------------------------
bundle exec inochi --help     # display help manual
bundle exec inochi --tasks    # list available tasks
------------------------------------------------------------------------------

=== $LOAD_PATH setup

Ensure that the `lib/` directory is listed in Ruby's `$LOAD_PATH` before you
use any libraries therein or run any executables in the `bin/` directory.

This can be achieved by passing an option to Ruby:

------------------------------------------------------------------------------
bundle exec ruby -Ilib bin/#{package_name}
bundle exec irb -Ilib -r #{package_name}
------------------------------------------------------------------------------

Or by setting the `$RUBYLIB` environment variable:

------------------------------------------------------------------------------
env RUBYLIB=lib bundle exec ruby bin/#{package_name}
env RUBYLIB=lib bundle exec irb -r #{package_name}
------------------------------------------------------------------------------

=== Running tests

Simply execute the included test runner, which sets up Ruby's `$LOAD_PATH` for
testing, loads the included `test/test_helper.rb` file, and then evaluates all
`test/**/*_test.rb` files:

------------------------------------------------------------------------------
ruby test/runner
------------------------------------------------------------------------------

Its exit status will indicate whether all tests have passed.  It may also
print additional pass/fail information depending on the testing library used
in the `test/test_helper.rb` file.

=== Contributing

// TODO: explain how someone can contribute their changes to your repository

<%= @code_repo_url %>[Fork this project on GitHub] and send a pull request.