Skip to content

Latest commit

 

History

History
85 lines (57 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

85 lines (57 loc) · 2.08 KB

Tips for Contributors

Summary

For non-doc fixes:

  • Provide changelog entry in the unreleased section of the CHANGELOG.md.
  • Ensure CI passes and that you added a test that passes with the fix and fails without the fix.
  • Optionally, squash all commits down to one with a nice commit message ONLY once final review is given. Make sure this single commit is rebased on top of master.
  • Please address all code review comments.
  • Ensure that docs are updated accordingly if a feature is added.

Commit Messages

From How to Write a Git Commit Message

The seven rules of a great git commit message

Keep in mind: This has all been said before.

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line
  6. Wrap the body at 72 characters
  7. Use the body to explain what and why vs. how

To run:

Tests

rake test

Linting

rake rubocop

or to autofix:

bundle exec rubocop -a

Debugging

Enable pry by setting an ENV value for USE_PRY. When you use pry, you may get a useless warning about circular references.

All ci

rake

Configuring to test changes with your app

Use the relative path syntax in your gemfile.

gem "webpacker_lite", path: "../../../webpacker_lite"

Advice for Project Maintainers and Contributors

What do project maintainers do? What sort of work is involved? sstephenson wrote in the turbolinks repo:

Why this is not still fully merged?

Releasing

Using gem-release.

If the version to bump is 2.0.3

git checkout master
git pull --rebase
gem bump --version 2.0.3
bundle
git commit -am "Update Gemfile.lock"
gem release --tag