CONTRIBUTING.md

Contributing

Bug reports and pull requests are welcome on GitHub: https://github.com/gi/handlebars-ruby.

1. Fork the repository: https://github.com/gi/handlebars-ruby.
2. Create an issue branch: git checkout -b issue-N/summary origin/develop)
3. Run setup: bin/setup.
4. Add tests for your updates.
5. Run tests: bin/test.
6. Run linter: bin/lint.
7. Commit changes: git commit -am '[#N] Summary'.
8. Push changes: git push origin head.
9. Create a pull request targeting develop.

Branches

This repository follows a modified version of the Gitflow Workflow:

• The default development branch is develop.
• The main release branch is main.

Development

Setup

Run bin/setup to install dependencies.

Console

Run bin/console for an interactive prompt that will allow you to experiment.

Test

Run bin/test to run the tests.

Install

Run bin/rake install to install this gem onto your local machine.

Releases

Releases are created automatically by continuous deployment.

Please avoid creating releases manually.

To create a new release:

1. Checkout a new branch from develop:

   git fetch origin develop
   git checkout -b release-x.y.z origin/develop

2. Update the version number:

   bin/version x.y.z
   bin/setup

3. Update the changelog:
   • add mising entries
   • move [Unreleased] to [x.y.z] - YYYY-MM-DD
4. Commit the changes:

   git commit -m 'vx.y.z'

5. Push the new branch:

   git push -u origin head

6. Create a merge/pull request to main.

When the main branch is updated, continuous deployment will tag and push a new release.

Afterwards:

1. Create a merge/pull request from main to develop.