CONTRIBUTING.md

How to contribute

Bug reports and pull requests from users are what keep this project working.

Basics

1. Create an issue and describe your idea
2. Fork it
3. Create your feature branch (git checkout -b my-new-feature)
4. Commit your changes (git commit -am 'Add some feature')
5. Publish the branch (git push origin my-new-feature)
6. Create a new Pull Request

Checking your work

You can test your workflow with changelog generator with the skywinder/changelog_test repo.

You can run the test suite.

You can run RuboCop to check code style.

The default Rake task, runnable using rake, calls rubocop, then spec.

Write documentation

This project has documentation in a few places:

Introduction and usage

A friendly README.md written for many audiences.

Examples and advanced usage

The wiki.

API documentation

API documentation is written as YARD docblocks in the Ruby code.

This is rendered as Web pages on Rubydoc.info.

The completeness of the API documentation is measured on our page on the Inch CI website.

man page

man/git-generate-changelog.md

The man page is for the git generate-changelog Git sub-command, which is a wrapper for github_changelog_generator. That file is a Markdown file.

Use the ronn gem to generate .1 and .html artifacts like this: cd man; ronn git-generate-changelog.md