Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (26 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

34 lines (26 loc) · 1.48 KB

Contributing to the KeepAChangelog Manager gem

KeepAChangelogManager uses a very standard GitHub workflow.

  1. Fork the repository on github
  2. Make your desired changes
  3. Push to your personal fork
  4. Open a pull request

Pull requests will trigger a Travis CI job. The following two commands will be expected to pass (so you may want to run them locally before opening the pull request):

  • rubocop -D - code style tests
  • rspec - functional tests

Be prepared to write tests to accompany any code you would like to see merged.

Packaging the Gem

  • Merge pull request with new features
  • Run bash release-new-version.sh --increment-patch (or the argument of your choice) which does the following:
    • git stash save (at least before the gem build step, but easiest here).
    • git pull --rebase
    • Bump the version in lib/keepachangelog/version.rb and change it in README.md (since rubydoc.info doesn't always redirect to the latest version)
    • Update the sections of CHANGELOG.md by running bundle exec keepachangelog_manager.rb --increment-patch
    • git add README.md CHANGELOG.md lib/keepachangelog/version.rb
    • git commit -m "vVERSION bump"
    • git tag -a vVERSION -m "Released version VERSION"
    • gem build keepachangelog.gemspec
    • git stash pop
    • gem push keepachangelog-VERSION.gem
    • git push upstream
    • git push upstream --tags
  • Visit http://www.rubydoc.info/gems/keepachangelog/VERSION to initiate the doc generation process