Skip to content

Commit 669dcd0

Browse files
committed
doc: update CONTRIBUTING with release process
[skip ci]
1 parent cd77210 commit 669dcd0

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

Diff for: CONTRIBUTING.md

+18
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ Contributing to Rails Html Sanitizers
55

66
Rails Html Sanitizers is work of [many contributors](https://github.com/rails/rails-html-sanitizer/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/rails/rails-html-sanitizer/pulls), [propose features and discuss issues](https://github.com/rails/rails-html-sanitizer/issues).
77

8+
### How to submit a pull request
9+
810
#### Fork the Project
911

1012
Fork the [project on Github](https://github.com/rails/rails-html-sanitizer) and check out your copy.
@@ -97,3 +99,19 @@ It's likely that your change will not be merged and that the nitpicky maintainer
9799
#### Thank You
98100

99101
Please do know that we really appreciate and value your time and work. We love you, really.
102+
103+
### How to cut a release
104+
105+
A quick checklist:
106+
107+
- [ ] make sure CI is green! https://github.com/rails/rails-html-sanitizer/actions/workflows/ci.yml
108+
- [ ] update `CHANGELOG.md` and `lib/rails/html/sanitizer/version.rb`
109+
- [ ] run `bundle exec rake build`
110+
- [ ] create a git tag
111+
- [ ] `git push && git push --tags`
112+
- [ ] `gem push pkg/*.gem`
113+
- [ ] create a release at https://github.com/rails/rails-html-sanitizer/releases
114+
- if security-related,
115+
- [ ] publish the CVE
116+
- [ ] post to https://discuss.rubyonrails.org/c/security-announcements
117+
- [ ] submit a PR to https://github.com/rubysec/ruby-advisory-db

0 commit comments

Comments
 (0)