Skip to content

Commit cf9aa9d

Browse files
committed
doc: CONTRIBUTING.md to document the release process
[skip ci]
1 parent d0265ad commit cf9aa9d

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contributing to tailwindcss-rails
2+
3+
This doc is a brief introduction on modifying and maintaining this gem.
4+
5+
## Updating to the latest upstream tailwindcss version
6+
7+
Update `lib/tailwindcss/upstream.rb` with the upstream version.
8+
9+
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.
10+
11+
## Cutting a release
12+
13+
- bump the version
14+
- [ ] update `lib/tailwindcss/version.rb`
15+
- [ ] update `CHANGELOG.md`
16+
- [ ] commit and create a git tag
17+
- build the native gems:
18+
- [ ] `bundle exec rake clobber` to clean up possibly-old tailwindcss executables
19+
- [ ] `bundle exec rake package`
20+
- push
21+
- [ ] `for g in pkg/*.gem ; do gem push $g ; done`
22+
- [ ] `git push`
23+
- announce
24+
- [ ] create a release at https://github.com/rails/tailwindcss-rails/releases

0 commit comments

Comments
 (0)