Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

45 lines (28 loc) · 1.42 KB
Raw

Contributing to tailwindcss-rails

This doc is a brief introduction on modifying and maintaining this gem.

Testing this gem

Running the test suite

The unit tests are run with bundle exec rake test

There is an additional integration test which runs in CI, test/integration/user_journey_test.sh which you may also want to run.

Testing in a Rails app

If you want to test modifications to this gem, you must run rake download once to download the upstream tailwindcss executables.

Then you can point your Rails application's Gemfile at the local version of the gem as you normally would:

gem "tailwindcss-rails", path: "/path/to/tailwindcss-rails"

Updating to the latest upstream tailwindcss version

Update lib/tailwindcss/upstream.rb with the upstream version.

Run bundle exec rake clobber then bundle exec rake download to ensure the tailwindcss binaries can be downloaded, and that you have the correct versions on local disk.

Cutting a release

  • bump the version
    • update lib/tailwindcss/version.rb
    • update CHANGELOG.md
    • commit and create a git tag
  • build the native gems:
    • bundle exec rake clobber to clean up possibly-old tailwindcss executables
    • bundle exec rake package
  • push
    • for g in pkg/*.gem ; do gem push $g ; done
    • git push
  • announce